📢 Introducing Our Enhanced API with Streamlined URL Structure 🚀
We are thrilled to unveil our latest API version, brimming with innovative features and advancements based on your invaluable feedback. As part of this release, we are excited to introduce a streamlined URL structure, specifically designed to enhance the efficiency and simplicity of your integration process as well as some new endpoints to help on your integration journey.
What has changed?
Note
Prior Base URLs (
https://insight.{environment}.safetychain.com/API/rdTemplate/rdData.aspx) will remain active; however it is recommended to move all your endpoints as the existing will not be including any future enhancements.
- The BaseUrl has changed for all endpoints
Here you can see the new URL for all our record data extract requests
| Environment | BaseUrl |
|---|---|
| Stage | https://integrations.stage.safetychain.com/clientapis/v1.0 |
| Train | https://integrations.train.safetychain.com/clientapis/v1.0 |
| Production | https://integrations.safetychain.com/clientapis/v1.0 |
- _rdData _and _rdDataId _query parameters are not needed and there will be paths for each rdDataId
rdData query parameter will not be needed and all rdDataIds will be moved to paths; see examples below.
Note
All query parameters and authentications using your security token (ST) will remain the same.
| Path | Example URL |
|---|---|
| /setCache | https://integrations.stage.safetychain.com/clientapis/v1.0/setCache |
| /getRecords | `https://integrations.stage.safetychain.com/clientapis/v1.0/getRecords |
| /UC/getRecords | https://integrations.stage.safetychain.com/clientapis/v1.0/UC/getRecords |
| /getRecordSummary | https://integrations.stage.safetychain.com/clientapis/v1.0/getRecordSummary |
| /getRecordFields | https://integrations.stage.safetychain.com/clientapis/v1.0/getRecordFields |
| /UC/getRecordFields | https://integrations.stage.safetychain.com/clientapis/v1.0/UC/getRecordFields |
| /getVerifications | https://integrations.stage.safetychain.com/clientapis/v1.0/getVerifications |
| /getForms | https://integrations.stage.safetychain.com/clientapis/v1.0/getForms |
| /getFormsByResource | https://integrations.stage.safetychain.com/clientapis/v1.0/getFormsByResource |
| /getResources | https://integrations.stage.safetychain.com/clientapis/v1.0/getResources |
| /getLocations | https://integrations.stage.safetychain.com/clientapis/v1.0/getLocations |
| /getLocationsByResource | https://integrations.stage.safetychain.com/clientapis/v1.0/getLocationsByResource |
What's New?
We have also included some new endpoints for resources and supplier requirements to help pull data for reporting and other integrations.
| Path | Description |
|---|---|
| /getResourceDetails | Used to search resources and get the full categorical tree for your resource(s) |
| /getResourceAttributes | Used to search on resource or specific resource attributes and return a list of attributes for each resource. |
| /getRequirementSets | Used to search all available requirement sets/templates and return the list of requirement sets and their linked requirements. |
| /getInternalTasksRequirements | Used to search active requirement tasks to approve associated supplier or item requirements; this will return all requirement, task, supplier, and item ids. |
| /getSuppliersTasksRequirements | Used to search active requirement tasks that were provided to your supplier partner; it will return all requirement, task, document, supplier and item ids. |
What's Next?
Phase 2 (est. Q3 2023): New Structure and Bearer Authentication
The next stage to our improvements would be introducing a new structure to query your record data extract APIs and including a centralized authentication using JWT Bearer authentication flow.
This will provide you with the ability to utilize one authentication for both process and record data extract APIs as well as self service credential management.
Included in this will be new POST and query methods with streamlined response structures to help assist in retrieving data from your SafetyChain account.
Phase 3 (est. Q4 2023): New Endpoints
New endpoints for large data pulls to provide access to large requests of historical data dumps and added functionality for process endpoints. Process endpoints will also be streamlined with a centralized URL structure and new processes such as supplier onboarding and compliance APIs.