API-Fehler und Antworten

Dieser Referenzartikel behandelt die verschiedenen Fehler und Server-Antworten, die bei der Verwendung der Braze API auftreten können, und wie Sie diese beheben können.

Server-Antworten

Wenn Ihr POST-Payload von unseren Servern akzeptiert wurde, erhalten erfolgreiche Nachrichten die folgende Antwort:

1
2
3

{
  "message" : "success"
}

Beachten Sie, dass „success“ nur bedeutet, dass der RESTful-API-Payload korrekt aufgebaut war und an unsere Dienste für Push-Benachrichtigungen, E-Mails oder anderes Messaging übergeben wurde. Es bedeutet nicht, dass die Nachrichten tatsächlich zugestellt wurden, da weitere Faktoren die Zustellung der Nachricht verhindern können (zum Beispiel kann ein Gerät offline sein, das Push-Token von den Servern von Apple abgelehnt werden oder Sie haben eine unbekannte Nutzer-ID angegeben).

Warum gibt meine Anfrage „success“ zurück, obwohl keine Nachricht zugestellt wurde?

Eine Antwort mit message: success oder 2XX bedeutet, dass Braze die Anfrage für die beteiligten Endpunkte angenommen und in die Warteschlange gestellt hat – nicht, dass alle Empfänger:innen eine Nachricht erhalten haben. Beim Messaging hängt die Zustellung weiterhin von der Kanalberechtigung, Token, Anbieterfehlern und der Validierung der Inhalte ab. In der Tabelle der schwerwiegenden Fehler finden Sie HTTP-Fehler, die den Versand blockieren. Metriken zur nachgelagerten Zustellung finden Sie in den Analytics Ihrer Campaign oder Ihres Canvas.

Bei Endpunkten wie /users/identify, die keine Nachrichten versenden, bedeutet eine erfolgreiche Antwort nur, dass Braze die Anfrage zur Verarbeitung angenommen hat. Wenn kein:e Nutzer:in mit dem angegebenen Alias existiert oder der Alias zu einem Profil gehört, das bereits eine external_id hat, überspringt Braze die Identifizierung. Die API gibt trotzdem die ursprüngliche Erfolgsantwort zurück; es gibt keinen Fehler, der darauf hinweist, dass der Alias nicht zugeordnet wurde. Da bei alias_name die Groß- und Kleinschreibung beachtet wird, führt eine abweichende Schreibweise zum gleichen Ergebnis.

Wenn Ihre Nachricht erfolgreich ist, aber nicht schwerwiegende Fehler aufweist, erhalten Sie die folgende Antwort:

1
2
3

{
  "message" : "success", "errors" : [<minor error message>]
}

Im Erfolgsfall werden alle Nachrichten, die nicht von einem Fehler im Array errors betroffen sind, trotzdem zugestellt. Wenn Ihre Nachricht einen schwerwiegenden Fehler aufweist, erhalten Sie die folgende Antwort:

1
2
3

{
  "message" : <fatal error message>, "errors" : [<minor error message>]
}

Antworten für getrackte Sende-IDs

Analytics sind für Campaigns immer verfügbar. Darüber hinaus stehen Analytics für eine bestimmte Campaign-Sendeinstanz zur Verfügung, wenn die Campaign als Broadcast versendet wird. Wenn Tracking für eine bestimmte Campaign-Sendeinstanz verfügbar ist, erhalten Sie die folgende Antwort:

1
2
3

{
  "message": "success", "send_id" : "example_send_id"
}

Die bereitgestellte Sende-ID können Sie als Parameter für den Endpunkt /send/data_series verwenden, um sendungsspezifische Analytics abzurufen.

Fehler

Das Statuscode-Element einer Server-Antwort ist eine dreistellige Zahl. Die erste Ziffer des Codes gibt die Klasse der Antwort an.

• Die 2XX-Klasse von Statuscodes (nicht schwerwiegend) zeigt an, dass Ihre Anfrage erfolgreich empfangen, verstanden und akzeptiert wurde.
• Die 4XX-Klasse von Statuscodes (schwerwiegend) weist auf einen Client-Fehler hin. Eine vollständige Liste der 4XX-Fehlercodes und ihrer Beschreibungen finden Sie im Chart zu schwerwiegenden Fehlern.
• Die 5XX-Klasse von Statuscodes (schwerwiegend) weist auf einen Server-Fehler hin. Dafür gibt es mehrere mögliche Ursachen: Beispielsweise kann der Server, auf den Sie zugreifen möchten, die Anfrage nicht ausführen, der Server wird gerade gewartet und kann die Anfrage deshalb nicht ausführen, oder der Server ist einem hohen Datenaufkommen ausgesetzt. In diesem Fall empfehlen wir, Ihre Anfrage mit exponentiellem Backoff zu wiederholen. Bei einem Vorfall oder Ausfall kann Braze keine REST API-Aufrufe erneut ausführen, die während des Vorfallzeitraums fehlgeschlagen sind. Sie müssen alle Aufrufe, die in diesem Zeitraum fehlgeschlagen sind, selbst wiederholen.
  • Ein 502-Fehler ist ein Fehler, der auftritt, bevor die Anfrage den Zielserver erreicht.
  • Ein 503-Fehler bedeutet, dass die Anfrage den Zielserver erreicht hat, wir sie aber nicht abschließen können, weil nicht genügend Kapazität vorhanden ist, ein Netzwerkproblem vorliegt oder Ähnliches.
  • Ein 504-Fehler bedeutet, dass ein Server keine Antwort von einem anderen, vorgelagerten Server erhalten hat.

Schwerwiegende Fehler

Die folgenden Statuscodes und zugehörigen Fehlermeldungen werden zurückgegeben, wenn bei Ihrer Anfrage ein schwerwiegender Fehler auftritt.

Warnung

Alle folgenden Fehlercodes bedeuten, dass keine Nachrichten versendet werden.

Fehler beim Parsen des Anfragetexts

Braze gibt HTTP 400 zurück, wenn der Anfragetext kein gültiges JSON ist. Dies gilt für REST-Endpunkte, die einen JSON-Text akzeptieren, etwa POST, PUT und PATCH.

Das Feld error enthält die Meldung, dass Sie im Anfragetext gültiges application/json übergeben müssen. Möglicherweise sehen Sie auch Error while parsing request body. Please check your syntax.

Häufige Ursachen sind abschließende Kommas, Kommentare innerhalb des JSON, Strings in einfachen Anführungszeichen, eine zusätzliche öffnende { vor der Payload oder das Senden eines verketteten Strings statt eines JSON-codierten Objekts.

Bevor Sie es erneut versuchen:

1. Validieren Sie die Payload mit einem JSON-Linter.
2. Setzen Sie Content-Type: application/json und senden Sie UTF-8-codiertes JSON.
3. Stellen Sie sicher, dass Ihr HTTP-Client das Objekt JSON-codiert, statt rohe Strings zu verketten.

Informationen zur Payload-Größe und zu den Objektlimits pro Anfrage bei /users/track finden Sie unter Warum erhalte ich 400 Bad Request mit einem Syntax- oder Parse-Fehler?.