Web API Server Configuration

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Revision as of 11:56, 7 August 2014 by Robert (talk | contribs) (Created page with '=Introduction= Using the Web API you can remotely access and update your CommitCRM system via HTTP and easily integrate …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 runs as part of the CommitCRM Server service which is also used for the Email Connector and Alerts Server.


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:


  1. DbQry - this lets you query data
  2. 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.