Outbound API FAQ-Draft
- Prasanta Patri
Common Questions :
What is the message format supported for Ideagen APIs?
The standard message format is JSON.
Which modules outbound are supported for data extraction ?
Ideagen EHS provides API Services for below modules -
Foundation
Incident Management
Audits
Sustainability
Calendar
Sustainability
Learning Management
Behavioural Based Safety
OPM
3. What is the authentication mechanism followed for the APIs?
The APIs use token based authentication. The JWT token gets generated based on user credentials having access to the EHS system.
4. What is the lifetime of the JWT Token?
The standard validity of JWT Token is 2 hours,after which the token needs to be regenerated and used for calling API Endpoints.
4. Does API user credentials get transmitted during API Calls?
No, the user credentials are just used for generating the encrypted JWT Token, and does not get transmitted while calling API Endpoints.
5. What functionality can a user perform?
The user can retrieve system data based on requirement and subscription.
6. How will the user be notfied about downtime?
Usually there is downtime during product version releases for which there will be a prior communication sent.
7. How are the errors handled?
The user will be able to see standard error messages and codes if there is any error while calling the APIs. Please find below Error/Validation messages :
8. What steps to be taken if there is error while calling the API?
The first step is to ensure that there is no connectivity issues, you can navigate below link in browser to see if home page is accessible.
https://integrationsvc.processmap.com/outbound/
Then check for the URL Details if it is correctly entered
If the above information is correct and there is still an issue then check the parameters/data passed for calling the API Endpoints.
If the issue still remains unresolved, you can reach out to the Ideagen EHS Customer Support team.
Is there any limitation while extracting system data?
Yes, the data can be extracted only for specific interval which is mentioned in detailed documentation for each EHS API Endpoint(example - max 1 year/2 years based on the documentation).
The data can be extracted only by the location except the Foundation API Services(Location).
Does the data extract consider my EHS Platform Application Permissions?
A separate user will be created to access the API endpoints which
Related content
© 2018 ProcessMAP Corporation, All Rights Reserved Confidential, may not be disclosed without the express permission of ProcessMAP Corporation