Erreurs et réponses d’API

Cet article de référence couvre les diverses erreurs et réponses du serveur qui peuvent apparaître lors de l’utilisation de l’API Braze et la façon de les résoudre.

Réponses du serveur

Si votre charge utile POST a été acceptée par nos serveurs, les messages réussis reçoivent la réponse suivante :

1
2
3
{
  "message" : "success"
}

Notez que la réussite signifie que la charge utile de l’API RESTful a été correctement créée et transmise à notre notification push ou à nos e-mails ou autres services de messagerie. Cela ne signifie pas que les messages ont effectivement été envoyés, car des facteurs supplémentaires peuvent empêcher l’envoi du message (par exemple, un appareil peut être hors ligne, le jeton push peut être rejeté par les serveurs d’Apple, vous pouvez avoir fourni un ID utilisateur inconnu).

Si votre message aboutit mais comporte des erreurs non fatales, vous recevez la réponse suivante :

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

En cas de succès, tous les messages qui n’ont pas été affectés par une erreur dans le tableau errors sont toujours envoyés. Si votre message comporte une erreur fatale, vous recevez la réponse suivante :

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

Réponses pour les ID d’envoi suivis

Les analyses sont toujours disponibles pour les campagnes. De plus, les analyses sont disponibles pour une instance spécifique de campagne lorsque celle-ci est envoyée en tant que diffusion. Lorsque le suivi est disponible pour une instance d’envoi de campagne spécifique, vous recevez la réponse suivante :

1
2
3
{
  "message": "success", "send_id" : "example_send_id"
}

L’ID d’envoi fourni peut être utilisé comme paramètre pour l’endpoint /send/data_series afin d’obtenir des analyses/analytiques spécifiques à l’envoi.

Erreurs

L’élément du code d’état d’une réponse serveur est un numéro à 3 chiffres où le premier chiffre du code définit la classe de réponse.

• Le code d’état de classe 2XX (non fatal) indique que votre demande a été reçue, comprise et acceptée avec succès.
• La classe 4XX du code de statut (fatal) indique une erreur du client. Reportez-vous au tableau des erreurs fatales pour obtenir une liste complète des codes d’erreur et descriptions de la classe 4XX.
• La classe 5XX du code de statut (fatal) indique une erreur du serveur. Il y a plusieurs causes possibles, par exemple, le serveur auquel vous essayez d’accéder n’est pas en mesure d’exécuter la requête, le serveur fait l’objet d’une maintenance qui l’empêche d’exécuter la requête, ou le serveur connaît des niveaux élevés de trafic. Dans ce cas, nous vous recommandons de réessayer votre demande avec un délai exponentiel. En cas d’incident ou de panne, Braze n’est pas en mesure de lire à nouveau un appel d’API REST qui a échoué pendant la fenêtre d’incident. Vous devez réessayer tous les appels qui ont échoué pendant la fenêtre d’incident.
  • Une erreur 502 est un échec avant que le message n’atteigne le serveur de destination.
  • Une erreur 503 signifie que la demande est parvenue jusqu’au serveur de destination, mais que nous ne pouvons pas la traiter en raison d’un manque de capacité, d’un problème de réseau ou d’un problème similaire.
  • Une erreur 504 indique qu’un serveur n’a pas reçu de réponse d’un autre serveur en amont.

Erreurs fatales

Les codes d’état suivants et les messages d’erreur associés sont renvoyés si votre demande rencontre une erreur fatale.