Create Ticket My Tickets Post Discussion
Login  Sign up

General Information

We offer an Application Programming Interface (API) that allows systematic access to the data available on our platform. This guide details the API, targeting software developers and system integrators.

Our API adopts the REST methodology through web services, ensuring an adaptable and straightforward interface accessible from nearly any coding language.

Integration is at the heart of our platform. As such, we facilitate sturdy bidirectional data exchange across various exposed objects.

Furthermore, all our APIs accommodate both JSON and XML data formats.

Note: XML requests must have each tage element in alphabetical order.

To access the various APIs, you must use the generated Integration Passkey which can be found on your Provider configuration page of the website. Keep this Integration Passkey safe since it is the principal key used for keeping your data secure.

The base URL for all Cloud APIs is http$://
(replace the "$" symbol with "s")

If you are running a Private Server, then the API will be available from the installed Server website’s root URL with the “/api/v2” suffix.

General Data Type Notes

  1. If not explicitly stated, date values are expected to be formatted using ISO 8601 format: YYYY-MM-DDTHH:MI:SSZ 
    Where the time zone is UTC, time is in 24-hour values, and the “T” and “Z” are delimiters.
  2. All latitude and longitude data values are unprojected and use the WGS84 ellipsoid.

API HTTP Status Codes

We don't use many HTTP codes on our API; our error messages are generally included in the response body.

Generally speaking, successful API calls will return a 200 HTTP code.

If the API call has an error result, you will get one of the following.

Bad Request - this occurs when missing or invalid parameters are submitted in the request.
405Method Not Allowed - this occurs if the API endpoint you are attempting to call does not exist.
401Unauthorized - your integration key or company id is not valid.

All other errors usually are returned under a 500 Internal Server Error.

As mentioned above, if you get one of the above HTTP error codes, the response body will include more details of the error.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.