...
These are all part of the “API Import“ role.
Tracking
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/operation/tracking
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Tracking
Async Tracking (for releases after 2024-01-25)
Base URL: [CustomerName]-[Environment]-api-link.bizbrains.com/api/rest/operation/async-tracking
Authentication type(s): OAuth, Resource Owner, Personal Access Token
Resource owner required role: API Tracking
The main purpose of the asynchronous tracking interface is to allow faster tracking than with the synchronous tracking by making each tracking independent of the others, so that the tracking party can continue its work without waiting for trackings to complete. Because each tracking request needs to be independent of any others, the async tracking interface changes the way that interchanges and documents are identified. In the synchronous tracking scenario the server generates identifiers and the tracking party has to wait for the identifier before it can generate the next tracking. With asynchronous tracking, the tracking partner assigns a guid to each interchange and document and use these to continue tracking without waiting. When trackings are persisted to the Link database identifiers are still generated as usual, but the individual tracking calls are resolved using the guids.
In order to facilitate the needed processing speed, async tracking calls do not update Link in real time. Instead, the calls are simply persisted to a staging database, from which they can be synchronized to Link via a scheduler task using the “Async tracking synchronization” scheduler task handler. This means that tracking data sent to Link using the async tracking interface will not be immediately available in Link, only after the next time the synchronization scheduler task runs. This is a necessary tradeoff in order to achieve the near-instantaneous processing of the tracking requests.
Developing with Bizbrains.Link.Api.Proxy
...