EHQ can be integrated with other applications and tools using the in-built APIs provided. The EHQ API is REST based and uses user JSON for serialization and Basic Authentication over SSL for authentication and encrypted communication. The access credentials of any admin user in the EHQ site in question can be used to access the API. Non-admin access is not available.

Typical Site Structure

Every organisation that works with EHQ usually has one EHQ license that allows them to maintain a single EHQ site. There are some cases where multiple EHQ sites are covered under the same license. If that the case, each site is still managed and administered individually.

Each site is unique in its domain and all calls are made directly to the site's domain. Below is a visual representation of a simplified typical EHQ site structure.

API Utilisation

Our API is free for use for all our customers. We reserve the right to implement changes to our API as required and will endeavour to communicate changes to our customers if they are required. Our API is strictly monitored for misuse and to ensure performance. Any parties found to be misusing our API's for malicious use may face penalties or sanctions.

API Support

We provide support for our API as per our other product and services and are happy to answer your questions and resolve any issues. Please contact our support team via if you have any concerns. We do not provide support for 3rd party integration design and development unless we have otherwise been engaged via a services agreement.

API Documentation

To access further API documentation in our Help Desk, you must be logged into your EHQ site as an admin. You may also request an offline version of our documentation via request to our support team.

Did this answer your question?