1_Getting_Started.md

Erste Schritte zur API Nutzung

①

Registrieren Sie sich für einen Account, um einen Zugriff auf eine API zu bekommen. Im Rahmen der Registrierung bekommen Sie durch das System eine eindeutige ID (Beispiel-ID) mitgeteilt. Aus dieser Account-ID leiten sich mit einem entsprechenden Präfix die Sender-ID (Senderpräfix_Beispiel-ID) und Subscriber-ID (Subscriberpräfix_Beispiel-ID) ab. (Siehe [Link auf „Authentifizierung und Autorisierung“ Abschnitt / Unterseite für Registrierung eines Accounts])

②

Für den Zugriff auf die API fügen Sie dem Account einen Client hinzu und vergeben Sie dem Client die entsprechenden Scopes. (Siehe [Link auf „Authentifizierung und Autorisierung“ Abschnitt / Unterseite für Clientanlage und Scope Vergabe].

③

Für einen einfachen Einstieg zum Test der API können Sie folgende Postman Collection (Link auf die Collection) nutzen und mittels des Postman REST Clients die Anfragen an die API durchführen. (Für nähere Informationen zu Postman siehe https://www.postman.com/) Alternativ können Sie die Anfragen auch mittels eigener Anwendungen oder alternative REST Client durchführen. Falls Sie nur für die Sender oder Subscriber Seite entwickeln, nutzen sie den folgenden Vorschlag auf Basis Postman [Link auf Postman basierte Teststrategie als Unterseite von „Weiterführende Informationen“].

④

Für jede Anfrage an die API Endpunkte ist ein gültiger JWT-Token mit der Anfrage mitzusenden. Für nähere Informationen zum Abruf eines JWT-Token siehe [Link auf „Authentifizierung und Autorisierung“ Abschnitt / Unterseite für Token Abruf].

⑤

Verweis auf die Ablage der Open API Spec im Original Abschließendes Beispiel eines API Abrufs mit Token Abruf und einem Beispiel unter Nutzung des Tokens.

Wie geht es weiter?

Service Desk

Für Fragen, Anregungen und sonstiges Feedback steht Ihnen unser FIT-Connect Service Desk zur Verfügung.