Getting Started
Dieser Guide gibt einen kurzen Überblick über die Funktionen des API-Portals. Es ist ohne Anmeldung möglich sich die zur Verfügung stehenden APIs und deren Funktionsweise anzusehen. Um die Benutzung von APIs beantragen zu können ist ein Login mit einem gültigen Account nötig.
01
Account
Den Account erhalten Sie über die Einladung von ihrem zuständigen API-Berater.
02
link2rail API-Portfolio
Unter dem Link link2rail API-Portfolio werden die zur Verfügung stehenden APIs aufgelistet. Mit dem Klick auf eine API werden die zugehörigen Informationen angezeigt. Die meisten APIs verfügen über eine DEMO-Version mit identischen Funktionalitäten wie die Produktion. Die Demo Versionen sind jeweils an ein (vom Produktivsystem unabhängiges) Testsystem angebunden. (Für die Track&Trace API gibt es keine DEMO-Version.)
03
Nutzungspläne
Um die APIs aufrufen zu können abonnieren Sie bitte den default plan. Die anderen Nutzungspläne müssen im Vorfeld abgestimmt werden.
04
Anwendung
Nach der Auswahl des Nutzungsplans kann eine existierende Anwendung gewählt werden, oder eine Neue angelegt. Unter einer Anwendung werden jeweils APIs zusammengefasst, die von einem Kundensystem aufgerufen werden. Alle APIs unter einer Anwendung verwenden dieselben Security Tokens (Client-ID, Client Secret). Diese werden für den Aufruf der APIs benötigt und müssen beim Erstellen der Anwendung gespeichert werden. Jede API kann jeweils einmal abonniert werden.
05
Genehmigung
Nach Beantragung der API mit dem Nutzungsplan wird intern geprüft, ob es sich um eine gültige Anfrage handelt. Sie erhalten innerhalb von 3 Werktagen eine Mail, ob das Abonnement genehmigt wurde.
Nach der Genehmigung können Sie die API testen und aufrufen.
06
Versuchen Sie es
Hierzu loggen Sie sich wieder in dem Portal ein und wählen unter dem Menüpunkt Anwendungen die gewählte Anwendung und API aus. Jetzt ist es nicht nur möglich sich die Beschreibung anzusehen, sondern auch die Versuchen Sie es Funktion zu nutzen.
Bei Fragen und Anmerkungen wenden Sie sich gerne an Ihren API-Berater.