OpusCapita Track API enables Business Network customers to search, monitor and extract transaction event data in real-time. API offers same source data as the Track and trace application in the Business Network Portal. The API can be used for customer´s own reporting and monitoring applications.
If a customer uses robotics to retrieve transaction data, it's better to use the Track API instead of UI-based RPA tools. UI components frequently change, which can break these preprogrammed UI RPA tools.
Track API utilizes OpenID connect and OAuth 2.0 protocol for authentication.
This documentation gives you the basic overview of the implementation and usage of the API. For more detailed information, please check the documentation and specification links in the below table. Accessing the information requires login to Business Network Portal.
Environment | Documentation | Json spec |
|---|---|---|
Test - Stage | https://stage.businessnetwork.opuscapita.com/track/api/docs/ | stage.businessnetwork.opuscapita.com/track/api/open-api-spec.json |
Production |
Authentication - OpenID Connect
Track API is compliant with OAuth 2.0 authentication protocol. You need below credentials, including a client ID and client secret, to authenticate API-users and gain access to OpusCapita Track API endpoints. API credentials are provided to you as part of the implementation project:
Client ID
Client secret
User name
Password
Endpoints
Below endpoint examples are for the testing environment.
Authorization: https://stage.businessnetwork.opuscapita.com/authorize
Request header: /track/api/transactions
Request body: see above links to the Swagger documentation.