About Our Open APIs
Our APIs provide customers the ability to access a wide range of data and information relevant to their provider and services. Our API documentation includes representative code snippets and example requests/responses.
Our Open APIs have been designed to allow more technical enterprise childcare businesses to access their data within the platform. The list of available APIs will be expanded over time based upon user feedback.
Please Note: Enterprise APIs are designed to be implemented and understood by technical software development teams. Integration with specific business platforms is to be undertaken at the discretion of the child care provider.
Notes on APIs
- APIs are currently only allowing providers to retrieve data.
- APIs are not allowing providers to update or create data within Office.
- APIs incur additional charges outside of regular service billing.
Open Enterprise API documentation can be found here.
Access to Enterprise APIs are issued at a per-provider basis and require you to contact the team to be provisioned an API key. Follow the below steps to get started:
- Get in contact with your account manager to discuss our Open APIs.
- Review our billing plans and API documentation to confirm our API terms and conditions.
- We will configure an enterprise API key with API request limits issued at a provider level.
- API keys will be issued to you by your account manager.
We will bill API quota usages along with your regular monthly billing cycle. Please ensure you understand and agree to our billing terms before using the APIs.
Understanding API Limits
There are limits to the number of API calls that your application can make against a particular provider utilising an Enterprise API key.
We will impose a monthly API Key limit: determined during setup.
Enterprise APIs also have a hard request limit: up to 1 request per second.
If you exceed either rate limit you will receive an HTTP 503 (Service Unavailable) response with the following message in the http response body:
“oauth_problem=rate limit exceeded&oauth_problem_advice=please wait before retrying the xplor api”
You will also receive an X-Rate-Limit-Problem HTTP header with the value of Daily or Minute to indicate which rate limit you have hit.
If you encounter a limit, do not continue to make requests as this may continue to add to your limitation. The most common issue encountered is the 1 request/sec rate limit. If possible, queue requests and allow a few seconds before attempting to make another request.
What if I exceed my monthly plan limit?
Quite often, applications that you might believe would exceed the API rate limits, can in fact work within the limits by analysing the structure of how you intend to use the API.
However, if you exceed monthly limit, feel free to contact us to purchase additional requests.
What is the best way to handle API requests on my side?
It is recommended that applications queue requests to the API. This will allow you to ensure requests are within the supported limits, and will also allow your application to function even in the event that it cannot reach the API temporarily.