Setting up API access
Who is this article for?IT Personnel setting up API access.
Administrator permissions are required.
This guide explains how to use the API offered by Ideagen EHS Core to integrate data management and analytics into your applications, enabling seamless automation, real-time insights, and customised reporting solutions.
Understanding the API
API (application programming interface) access to Ideagen EHS Core Software facilitates the bi-directional flow of information in a secure and structured manner. Common uses of the API include:
- Management of users, assets, and companies from external systems
- Reading of data for import to external systems
The RESTful API has predefined, controlled endpoints outlined in the SwaggerHub documentation. To access the API, a username and password is exchanged for an access token. Each access token is linked to a user that exists on the platform and adheres to the user's access privileges.
Using the authenticated API
Once authenticated, the API with the correct privileges will:
- List current organisation structure
- List available roles
- Facilitate the creation of new users
- Update existing user profiles
- View user profile for one or more users
- Facilitate the creation of new companies
- Update existing companies
- View one or more companies
- Facilitate the creation of new assets (under development)
- Update existing assets (under development)
- View one or more assets (under development)
Accessing API documentation
For documentation and latest updates on the API, visit the SwaggerHub page:
http://api.luciditysoftware.com.au/
Requesting API access
To set up API access to your organisation's Ideagen EHS Core Software instance:
- Log a ticket with Ideagen EHS Core Support.
- Wait for the sales team to provide a quote.
Note: If you have existing access and would like to request new endpoints, follow the same process.
Creating an API token
An API token can be created against a user account (accessible via the Access Module). However, it needs to be enabled first.
To enable the public API feature:
- Contact Ideagen Support to turn on the public API feature for your site.
To create an API token once enabled:
- Go to Access.
- Select Users.
- Edit the user account.
- Locate the Public API token generation section at the top of the page.