API (Application Programming Interface) allows the EHS Platform to interact with other software applications.
Setting up an API connection requires involvement from an HSI team member. Please reach out to your CSM or our customer support team to learn more about this process.
API provides an easy way to integrate third-party applications with our product. The API is organised around REST, it accepts form-encoded or JSON bodies and returns JSON encoded responses. It uses standard HTTP response codes and verbs.
A couple of points to note: special care has been taken to ensure that the API follows the logic and behaviours of the front end. So, a Get request will return all records you have view rights for as per your role - however you can use a special call to check if you have adopted rights as a result of having access to a module record that record is attached to.
This is an important step both from an API perspective but also from an HSI perspective. Using these types of tools, actions can be created to link to records in other HSI properties, further opening up the Actions system for some broader use cases.
For additional assistance with API, please fill out a support request via Customer Hub.