New article
Recently updated
Using the Ideagen Machine Safety Public API
Who is this article for?
Users managing the API integration between the solution and third-party platforms.
Public API access is required.
The Ideagen Machine Safety Public API allows data from Machine Safety Risk Assessments, Machines, Inspections, and Risk Actions to be integrated with third-party applications such as ServiceNow, asset management platforms, maintenance systems, and custom reporting tools.
1. Public API
The API provides a set of RESTful endpoints that enable you to:
- Retrieve assessments, machines, inspections, and risk actions
- Assign risk actions to individuals
- Add comments to risk actions
- Close and reopen risk actions
- Mark risk actions as not required
- Test integrations using the Sandbox environment
2. Environments
The Ideagen Machine Safety API includes a Sandbox environment for safe testing and development. This provides a full-featured environment with sample data that can be used to develop and test integrations without affecting live data.
Two Swagger environments are available:
| Environment | URL | Purpose |
|---|---|---|
| Production | https://api.machinesafety.ideagen.com/swagger/index.html | Live API. Documents the current released version |
| Sandbox | http://sandbox.api.machinesafety.ideagen.com/ | Safe testing space with sample data that can be reset at any time |
Changes made in the Sandbox do not affect live data. To restore the Sandbox to its default state at any point during development, use the POST /v1/sandbox/reset endpoint.
3. Authorisation
The Ideagen Machine Safety API uses API key-based authorisation. Two security keys are required for all API requests:
| Key | Description |
|---|---|
| Client ID | A unique identifier for your Machine Safety membership |
| Client Secret | A secret key paired with the Client ID to authenticate requests |
Once API access has been enabled for your Machine Safety membership, these values are configured via the Company Administration page in Ideagen Machine Safety.
The Client ID and Client Secret are then entered via the Authorize button in the Swagger interface.
Important
The Client Secret is only visible when it is first generated. Subsequent views show a masked value only. Resetting the Client Secret will invalidate any previously generated tokens.
Note
To request API access for your Machine Safety membership, contact your Ideagen account manager or the Machine Safety support team.