Zum Inhalt springen

Einführung ​

Willkommen in der API-Dokumentation für Pocket Alert. Dieses Dokument gibt dir einen umfassenden Überblick über die Möglichkeiten unserer API und hilft dir, die Zusammenarbeit mit unserem System reibungslos zu gestalten. Unten findest du die wichtigsten Informationen zur Authentifizierung, die du vor jeder API-Anfrage erledigen musst.

Authentifizierung ​

Unsere API unterstützt zwei Authentifizierungsmethoden, damit du die passende für deinen Anwendungsfall und deine Vorlieben wählen kannst:

1. JWT-Token-Authentifizierung ​

Du kannst über unsere API-Authentifizierung einen JWT-Token (JSON Web Token) abrufen.

Um mit der JWT-Token-Authentifizierung zu starten, sende eine Anfrage an den Autorisierungs-Endpunkt, wie in den folgenden Abschnitten dieser Dokumentation beschrieben.

2. Vorab erstellte Tokens ​

Alternativ kannst du für die Authentifizierung vorab erstellte Tokens verwenden. Diese Tokens erstellst und verwaltest du im Bereich API-Schlüssel deines Kontos. Diese Methode bietet dir einen unkomplizierten Zugang zu unserer API, ohne dass ein zusätzlicher Autorisierungsschritt nötig ist.

Lies weiter in den nächsten Abschnitten, um tiefer in die Details unserer API einzusteigen, einschließlich Endpunktbeschreibungen, Beispiele für Anfragen und Antworten, Statuscodes, Fehlermeldungen und mehr. Dein Weg zu einer reibungslosen Integration mit unserem Service beginnt genau hier!

Wichtiger Hinweis ​

Achte bei Anfragen an unsere API darauf, die nötigen Header in deine Anfrage aufzunehmen.

Du kannst jede der Autorisierungsarten verwenden, wir empfehlen jedoch Tokens. So kannst du den Zugriff verschiedener Dienste und Anwendungen auf deine Daten voneinander trennen.

Zur Schnellstart-Anleitung ​

Pocket Alert Dokumentation