Getting Started
The purpose of this guide is to briefly describe the functions of this portal. Without registration it is possible to browse the API-Portfolio and view the descriptions and specifications of the APIs. To use or test an API a valid account is necessary.
01
Account
You can receive the account via an invitation from your responsible API/EDI consultant.
02
link2rail API portfolio
The available APIs can be viewed within the link2rail API portfolio. Choosing an API displays the associated information. Most APIs have a DEMO version with identical functionality to the production version. The DEMO versions are each connected to a test system. These systems are completely independent from each other, it is not possible to use production data in a DEMO system. (There is no DEMO version for the Track&Trace API.)
03
Usage plans
To be able to access the API, please subscribe to the default plan. The other usage plans must be agreed in advance.
04
Application
After selecting the usage plan, an existing application can be chosen, or a new one created. It is best practice to group APIs that are called by the same customer system within one application. All APIs in the same application use the same security tokens (client ID, client secret). These are required to call the APIs and must be saved when the application is created. Each API can be subscribed once.
05
Approval
After applying for the API by subscribing a usage plan, an internal check is carried out to determine whether it is a valid request. You will receive an email within 3 working days to let you know whether the subscription has been approved.
After approval, you can use the “try it” functionality as well as call the API from external systems.
06
Try it
We recommend logging back into the portal and to choose the Applications menu item. After choosing the application and API a list of the endpoints is shown on the left side. After choosing one of the endpoints the try it menu item is accessible now.
If you have any questions or comments, please contact your API/EDI consultant.