API Token

API Token

Der API-Token ist für den Zugriff auf unsere GraphQL-Schnittstelle erforderlich.

API_Token

Zugriff auf die API

Die Abfrage der Daten über die API erfolgt über den GraphQL-Endpunkt. Es existieren GraphQL-Bibliotheken für alle gängigen Programmiersprachen. Alternativ können Abfragen ähnlich wie bei Rest-APIs als gewöhnliche HTTP-Requests gestellt werden.

Im Bereich Zugriffsdaten finden Sie alle erforderlichen Informationen, die benötigt werden um Daten von der GraphQL-Schnittstelle abzufragen.

Altair GraphQL Client

Zum Test der API und einfachem Abfragen von Daten von unserer Schnittstelle haben wir den GraphQL-Web Client Altair bereitgestellt. Zudem ist dort eine automatisch generierte Dokumentation der API. Die URL zum Aufrufen des Web Clients finden Sie unterhalb des Bereichs „Zugriffsdaten“.

Der Endpunkt ist bereits voreingestellt. Bitte fügen Sie vor dem Verbinden den Authorization-Header in den Einstellungen von Altair hinzu.

Header: Authorization
Wert: Bearer [Token]

Informationen zum Hinzufügen von Headern entnehmen Sie bitte der Altair-Dokumentation: https://altairgraphql.dev/docs/features/headers.html

Automatisiertes Abfragen der API

Für GraphQL gibt es für die gängigen Programmiersprachen (JavaScript, .NET, Java, Python, …) Bibliotheken zum einfachen Abfragen der Daten.

Alle für den Zugriff notwendigen Informationen (Endpunkt, Authorization-Header) finden Sie im Bereich „Zugriffsdaten“.

Hier finden Sie eine Auflistung einiger GraphQL-Bibliotheken: https://graphql.org/code/

Da die GraphQL-Daten über HTTP (ähnlich zu REST-APIs) abgefragt werden, können Sie auch eine einfache HTTP-Client-Bibliothek verwenden. Die abgefragten Daten werden im JSON-Format zurückgegeben.