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, thus robust two-way data transfer is supported on several of the various objects exposed.
All APIs support both JSON and raw XML formats.
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 https://secure.iforms.africa/api/v2
If you are running Appenate 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.
We don't use a lot of 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:
400 Bad Request - this occurs when missing or invalid parameters are submitted in the request.
405 Method Not Allowed - this occurs if the API endpoint you are attempting to call does not exist.
401 Unauthorized - your integration key and/or company id is not valid
All other errors are normally returned under a 500 Internal Server Error
As mentioned above, if you get one of the above HTTP error codes then more details of the error will be included in the response body.
