Overview: Compliance allows general managers to manage API connections so that they can integrate external systems with their Compliance system.
Start from: The Compliance overview.
- Navigate to Chain Management > API Connections.
The API Connections page provides an interface for integrating external systems with the Compliance platform. For example, customers using automatic sensors to monitor refrigerator and freezer temperatures can connect these sensors via the API. This ensures real-time data capture, automating tasks like temperature monitoring without manual intervention. Additionally, API connections can integrate with Business Intelligence (BI) systems for advanced analytics and reporting.
Adding a New API Connection
- The Connection Settings screen will appear. Fill in the following mandatory fields:
- Integration Name: Specify the name of the integration.
- Connection Name: Provide a name for this specific connection.
- API Key: Enter the unique key for the API.
- API Password: Provide the password associated with the API.
- API URL: Enter the API endpoint URL.
- API Username: Add the username required for the API connection.
Note: Ensure all fields are filled correctly, as they are mandatory for the connection to function.
- Once all fields are completed, select Verify Connection to test the integration and confirm that it is working properly.
- After verifying the connection, select Save to complete the setup.
Managing API Connections
Once added, the API connection will appear in the API Connections list. From this page, you can use the Actions menu to:
- Edit: Update the integration details if needed.
- Delete: Remove the connection if it is no longer required.