General Information

Modified on Thu, 15 Oct 2020 at 03:35 AM

We provide an Application Programming Interface (API) for programmatic access to data hosted on the platform. This document outlines the API and is intended for software developers and systems integrators.

The API is exposed using web services in a REST approach, providing a flexible and simple set of interfaces that can be accessed from just about any programming language.

Our platform was built to integrate, so robust two-way data transfer is supported on several of the various objects exposed.

All APIs support both JSON and raw XML formats, with SOAP XML available by special request.
NOTE: XML requests must have each tag 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

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

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article