Skip to main content

API-Dokumentation

Abruf der OpenAPI Spezifikation​

In den jeweiligen Kategorien unterhalb von Production oder Staging finden Sie jeweils eine Seite mit dem Namen "Introduction".

Auf dieser Seite können Sie unter dem Button "Export" mit "OpenAPI Spec" immer die aktuellste OpenAPI Spezifikation abrufen.

OpenAPI Spec Export

Import der OpenAPI Spezifikation in Postman​

Die heruntergeladene OpenAPI Spezifikation kann beispielsweise in Postman als Postman Collection importiert werden. Gehen Sie dazu wie folgt vor:

  1. Melden Sie sich in Postman an.
  2. Öffnen Sie über das Hamburger-Menü den Punkt "File" und wählen Sie anschließend "Import..." aus.

Import-Menü in Postman öffnen

  1. Im Import-Menü können Sie entweder:
    • Das JSON der OpenAPI-Spezifikation einfügen.
    • Den Link zur OpenAPI JSON-Datei einfügen.

JSON- oder Link-Import in Postman

  1. Klicken Sie dann auf "Import"

Nutzung von Codebeispielen​

Auf der jeweiligen API-Dokumentationsseite können Sie den Code für verschiedene Programme und Programmiersprachen kopieren, der den gewünschten API-Aufruf absetzt.

Beispiele:​

API Programmaufruf Beispiel 1 API Programmaufruf Beispiel 2