Web API Server Configuration: Difference between revisions
No edit summary |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{usermanuals}} | |||
=Introduction= | =Introduction= | ||
Using the [[ | Using the [[API_Developers_Guide#API_by_HTTP_.28Web_API.29|Web API]] you can remotely access and update your RangerMSP system via HTTP and easily integrate with your own applications. The Web API components run as part of the CRM Server service which is used for the [http://{{SERVERNAME}}/products/email-connector/ Email Connector] and [http://{{SERVERNAME}}/products/alerts-server/ Alerts Server] modules. | ||
<br><br> | |||
=Configuration= | =Configuration= | ||
By default the | By default the RangerMSP Server will support API calls that come over port '''4964''' but you can change that by editing the following file: <br> | ||
* \ | * \RangerMSP\Server\CmtWSrv.ini | ||
| Line 22: | Line 25: | ||
* \ | * \RangerMSP\Server\CmtWPDbEng.ini<br> | ||
* \ | * \RangerMSP\Server\CmtWPDbQry.ini | ||
Note: After any .ini file change you must RESTART the ' | Note: After any .ini file change you must RESTART the 'CRM Server' service on your server.<br> | ||
Latest revision as of 11:31, 30 September 2021
Introduction
Using the Web API you can remotely access and update your RangerMSP system via HTTP and easily integrate with your own applications. The Web API components run as part of the CRM Server service which is used for the Email Connector and Alerts Server modules.
Configuration
By default the RangerMSP Server will support API calls that come over port 4964 but you can change that by editing the following file:
- \RangerMSP\Server\CmtWSrv.ini
Also, the API is divided into two modules:
- DbQry - this lets you query data
- DbEng - this lets you add/edit data.
You need to enable each API module separately and set up a password for each. This password is then provided when you connect remotely and only once the password is validated (and the module (DbQry / DbEng) is enabled), a received request is performed.
You enable these API modules by editing the following files (e.g. configure the setting to ON):
- \RangerMSP\Server\CmtWPDbEng.ini
- \RangerMSP\Server\CmtWPDbQry.ini
Note: After any .ini file change you must RESTART the 'CRM Server' service on your server.