Web API Server Configuration: Difference between revisions
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
=Introduction= | =Introduction= | ||
Using the [[Commit_API_Developers_Guide#API_by_HTTP_.28Web_API.29|Web API]] you can remotely access and update your CommitCRM system via HTTP and easily integrate with your own applications. The Web API components run as part of the CommitCRM Server service which is | Using the [[Commit_API_Developers_Guide#API_by_HTTP_.28Web_API.29|Web API]] you can remotely access and update your CommitCRM system via HTTP and easily integrate with your own applications. The Web API components run as part of the CommitCRM Server service which is used for the [http://www.commitcrm.com/products/email-connector/ Email Connector] and [http://www.commitcrm.com/products/alerts-server/ Alerts Server] modules. | ||
<br><br> | <br><br> | ||
Revision as of 13:06, 7 August 2014
Introduction
Using the Web API you can remotely access and update your CommitCRM system via HTTP and easily integrate with your own applications. The Web API components run as part of the CommitCRM Server service which is used for the Email Connector and Alerts Server modules.
Configuration
By default the CommitCRM Server will support API calls that come over port 4964 but you can change that by editing the following file:
- \CommitCRM\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):
- \CommitCRM\Server\CmtWPDbEng.ini
- \CommitCRM\Server\CmtWPDbQry.ini
Note: After any .ini file change you must RESTART the 'CommitCRM Server' service on your server.