Pushwoosh API-Übersicht

Die Pushwoosh-API ermöglicht es Entwicklern, mit der Pushwoosh-Plattform zu interagieren.

Was können Sie mit der Pushwoosh-API tun?

Mit der Pushwoosh-API erhalten Sie Zugriff auf eine umfangreiche Bibliothek von über 100 Methoden, die Ihnen Folgendes ermöglichen:

• Senden personalisierter Push-Benachrichtigungen
• Erstellen, Importieren, Exportieren und Verwalten von Benutzersegmenten für eine präzise Zielgruppenansprache
• Nutzung von Bulk-APIs zur Verwaltung von Benutzern/Geräten in Stapeln
• Konfigurieren von Anwendungen
• Verfolgen von Benutzerereignissen und Hinzufügen von Tags zu Benutzern, um die Zielgruppenansprache und Personalisierung zu verbessern
• Erstellen und Verwalten von Pushwoosh-Entitäten wie Voreinstellungen, Tags, Ereignissen, Anwendungen usw.
• Starten von Pushwoosh Customer Journeys über die API
• Abrufen umfassender Statistiken zu Customer Journeys und Push-/E-Mail-/SMS-Kampagnen.
• Implementieren von Geofencing, um standortbasierte Benachrichtigungen zu senden, wenn Benutzer bestimmte geografische Gebiete betreten oder verlassen
• Nahtlose Integration von Drittanbieterdiensten mit Pushwoosh

Um den vollen Umfang der verfügbaren Methoden zu erkunden und die umfangreichen Möglichkeiten der Pushwoosh-API zu entdecken, verweisen wir auf den Referenzindex der API-Methoden.

Authentifizierung

Die Pushwoosh-API verwendet API-Token zur Authentifizierung von Anfragen. Es gibt zwei Arten von Token: Server und Gerät, die jeweils für bestimmte API-Bereiche verwendet werden.

Jedes Pushwoosh-Konto wird mit einem standardmäßigen API-Zugriffstoken geliefert, das für die Pushwoosh Demo App erstellt wurde. Sie können Ihre API-Token im Pushwoosh Control Panel anzeigen, erstellen und verwalten.

Mehr erfahren

Ratenbegrenzungen

Eine Ratenbegrenzung ist die Anzahl der Anfragen, die die API in einem bestimmten Zeitraum empfangen kann. Während die meisten API-Anfragen in Pushwoosh nicht begrenzt sind, sind /createMessage und die entsprechenden Messaging API v2 Notify Anfragen auf 600 pro Minute begrenzt, um die Servicequalität für alle Benutzer zu gewährleisten.

Anfragen

HTTPS ist für alle API-Anfragen obligatorisch, um eine sichere Datenübertragung zu gewährleisten.

Antworten

Die Pushwoosh-API gibt in der Regel JSON-Antworten zurück.

Erfolgs- und Fehlercodes

Erfolgscodes

Wenn Ihre API-Anfrage erfolgreich verarbeitet wird, erhalten Sie einen Erfolgscode als Teil der Antwort.

HTTP-Statuscode	Statusmeldung	Beschreibung
200	OK	Pushwoosh hat die Anfrage erfolgreich verarbeitet

Bitte beachten Sie, dass eine HTTP 200-Antwort bedeutet, dass Ihre Anfrage verstanden und erfolgreich verarbeitet wurde, aber nicht den Erfolg der Aktion garantiert. Überprüfen Sie daher auf Fehler- oder Warnmeldungen (Zugriff verweigert, Anwendung nicht gefunden, ungültiger API-Schlüssel usw.), um den Erfolg der Aktion festzustellen.

Statuscode	Statusmeldung
200	Warnungen: Sie haben das Abonnentenlimit erreicht. Die Push-Nachricht wird nur an 1 zufälliges Gerät gesendet
200	Warnungen: Sie haben die Anzahl der auf Ihrem aktuellen Abonnementplan erlaubten aktiven Geräte überschritten.
210	Zugriff verweigert oder Anwendung nicht gefunden
210	Anwendung nicht gefunden
210	Anwendung gesperrt
210	Konto nicht gefunden
210	Konto wurde gesperrt
210	Gesperrtes Konto kann keine Gerätefilterung verwenden
210	API-Token oder Anwendung ist nicht festgelegt
210	Bitte wählen Sie mindestens eine Plattform aus
210	Ungültiges API-Token: Konto nicht gefunden
210	Kein Anwendungs- oder Gruppencode angegeben
210	API-Token, Anwendung oder Konto ist nicht festgelegt

Fehlercodes

Falls Ihre Anfrage nicht korrekt formatiert ist, Verarbeitungsprobleme auftreten oder andere Fehler auftreten, sendet Pushwoosh Ihnen einen Fehlercode, der die Art des Problems anzeigt und Ihnen hilft, das Problem effektiv zu beheben.

HTTP-Statuscode	Statusmeldung	Beschreibung
400	Bad request	Die Anfrage kann aufgrund fehlerhafter Syntax nicht erfüllt werden
401	Unauthorized	Die Authentifizierung ist fehlgeschlagen oder wurde nicht bereitgestellt
403	Token restrictions forbid this operation.	Ihrem Zugriffstoken fehlen die erforderlichen Berechtigungen, um die angeforderte Aktion auszuführen. Um dies zu beheben, überprüfen Sie die Berechtigungen Ihres Zugriffstokens im Pushwoosh Control Panel und passen Sie sie bei Bedarf an die Anforderungen für den spezifischen Vorgang an, den Sie ausführen möchten.
404	Resource not found	Zeigt an, dass die angeforderte Ressource, wie z. B. eine App, nicht gefunden werden konnte oder auf dem Server nicht existiert.
500	Internal error	Es gab ein unerwartetes Problem oder einen Fehler auf dem Server bei der Verarbeitung der API-Anfrage.