An application programming interface (API) specifies how some software components should interact with each other by specified rules. For example, if Software 1 is requesting data from Software 2, only allowed data is given.
All API requests are composed of light-weight JSON delivered as an HTTP POST request to the endpoint URL.
Full address to send JSON requests looks like this:
- #companyname# is the subdomain
- #module# is the module accessed ("contacts")
- #action# (optional) what to do with the selected object. Possible options are ("modify","delete").
- #id# (optional) what object to get
Data can be requested only with the API key. An API is site specific and must be handled as a password.
If the same environment has need for several API-s, several API keys need to be requested.
Read the detailed API documentation.
If you wish to use the API, please contact us at email@example.com or your client manager.