API-Zugriffstoken

Ein API-Zugriffstoken ist eine eindeutige Kennung, die einem bestimmten Projekt oder mehreren Projekten in Ihrem Konto zugewiesen ist. Es authentifiziert Ihr Konto für die Verwaltung Ihrer Projekte über die API, einschließlich Kontoänderungen, Senden von Nachrichten, Bearbeiten von Projekten usw.

Arten von API-Zugriffstoken

Pushwoosh bietet zwei verschiedene Arten von API-Zugriffstoken: Server und Device.

Jeder Tokentyp ist nur für seinen spezifischen API-Geltungsbereich gültig. Ein Authentifizierungsfehler tritt auf, wenn das falsche Token verwendet wird.

Server-API-Token

Das Server-API-Token wird mit allen API-Methoden verwendet, außer denen der Device-API. Es sollte im Anfragetext im Feld auth enthalten sein.

Device-API-Token

Das Device-API-Token wird ausschließlich mit Methoden der Device-API verwendet. Es sollte in den HTTP-Anfrageheadern unter Verwendung des Authorization-Headers eingefügt werden. Unten sehen Sie ein Beispiel für das korrekte Header-Format:

Authorization: Token <device_api_token>

Ersetzen Sie <device_api_token> durch den tatsächlichen Wert Ihres Device-API-Tokens.

API-Zugriffstoken erstellen und verwalten

Sie können Ihre API-Zugriffstoken im Bereich API Access des Pushwoosh Control Panels anzeigen, erstellen und verwalten. Um darauf zuzugreifen, gehen Sie zu Settings → API Access. Pushwoosh Demo App Token

Standardmäßig enthält jedes Konto ein Token namens Pushwoosh Demo App, das als Server-Token eingerichtet ist.

Ein neues API-Zugriffstoken erstellen

So erstellen Sie ein neues API-Zugriffstoken:

Gehen Sie zum Bereich API Access im Control Panel.
Klicken Sie auf Generate New Token.
Wählen Sie im erscheinenden Fenster den Tokentyp aus:
- Server wird für die meisten API-Methoden verwendet (außer Device-API-Methoden).
- Device wird nur für Device-API-Methoden verwendet.
Geben Sie einen Namen für das Token ein.
Klicken Sie auf Generate, um das Token zu erstellen.

Ein neues Token generieren

Wichtig: Stellen Sie sicher, dass Sie dem Token Zugriff auf die richtige App in Ihrem Pushwoosh Control Panel gewähren. Erfahren Sie mehr

Das neue Token wird in der API-Zugriffsliste angezeigt. Von dort aus können Sie seinen Wert für die Verwendung in API-Anfragen kopieren oder seine Zugriffsberechtigungen nach Bedarf verwalten.

Ein Token verwalten

Um ein bestehendes API-Token zu verwalten, klicken Sie auf das Drei-Punkte-Menü (⋮) neben dem Tokeneintrag im Bereich API Access.

Ein Token verwalten

Die folgenden Optionen sind verfügbar:

Zugriff auf alle Projekte gewähren

Gewährt dem Token Zugriff auf alle Projekte in Ihrem Konto. Dies ermöglicht die vollständige Nutzung der API über alle Projekte hinweg.

Zugriff von allen Projekten entziehen

Entfernt den Zugriff des Tokens auf alle Projekte in Ihrem Konto. Das Token kann die API nicht mehr verwenden, bis der Zugriff erneut gewährt wird.

Token bearbeiten

Öffnet den Bildschirm Edit API Token Permissions, wo Sie:

Den Tokennamen ändern können
Den Tokenwert kopieren können
Auswählen können, auf welche Projekte das Token zugreifen darf, indem Sie sie in der Liste auswählen oder abwählen

Ein Token verwalten

Nachdem Sie Ihre Änderungen vorgenommen haben, klicken Sie auf Save, um sie zu übernehmen.

Token löschen

Entfernt das Token dauerhaft aus Ihrem Konto.

API-Anfragen autorisieren

Um API-Anfragen zu autorisieren, verwenden Sie den korrekten Typ des API-Zugriffstokens basierend auf der Art der API-Methode, die Sie aufrufen:

Für Server-API-Methoden

Fügen Sie das Token in das Feld “auth” des Anfragetextes ein:

Beispiel:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // Fügen Sie hier Ihr Server-Token ein
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

Für Device-API-Methoden

Verwenden Sie das Device-Token. Fügen Sie es im HTTP-Anfrageheader im folgenden Format ein:

Authorization: Token <device_api_token>

Ersetzen Sie <device_api_token> durch Ihren tatsächlichen Tokenwert.