Erros e respostas da API

Este artigo de referência aborda os vários erros e respostas do servidor que podem surgir ao usar a API do Braze e como solucioná-los.

Respostas do servidor

Se sua carga útil POST foi aceita por nossos servidores, as mensagens bem-sucedidas receberão a seguinte resposta:

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

Note que o sucesso significa apenas que a carga útil da API RESTful foi formada corretamente e passada para nossa notificação por push, e-mail ou outros serviços de envio de mensagens. Isso não significa que as mensagens foram realmente entregues, pois fatores adicionais podem impedir que a mensagem seja entregue (por exemplo, um dispositivo pode estar off-line, o token por push pode ser rejeitado pelos servidores da Apple, você pode ter fornecido um ID de usuário desconhecido).

Se sua mensagem for bem-sucedida, mas tiver erros não fatais, você receberá a seguinte resposta:

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

Em caso de sucesso, todas as mensagens que não foram afetadas por um erro na matriz errors ainda serão entregues. Se sua mensagem tiver um erro fatal, você receberá a seguinte resposta:

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

Respostas para IDs de envio rastreadas

A análise de dados está sempre disponível para campanhas. Além disso, a análise de dados está disponível para uma instância específica de envio de campanha quando a campanha é enviada como uma transmissão. Quando o rastreamento estiver disponível para uma instância específica de envio de campanha, você receberá a seguinte resposta:

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

O ID de envio fornecido pode ser usado como um parâmetro para o endpoint /send/data_series para extrair análises específicas de dados de envio.

Erros

O elemento de código de status de uma resposta do servidor é um número de três dígitos em que o primeiro dígito do código define a classe da resposta.

• A classe 2XX do código de status (não fatal) indica que sua solicitação foi recebida, compreendida e aceita com êxito.
• A classe 4XX do código de status (fatal) indica um erro do cliente. Consulte a tabela de erros fatais para obter uma lista completa dos códigos de erro 4XX e suas descrições.
• A classe 5XX do código de status (fatal) indica um erro do servidor. Há várias causas possíveis, por exemplo, o servidor que você está tentando acessar não consegue executar a solicitação, o servidor está passando por manutenção, o que o impede de executar a solicitação, ou o servidor está com altos níveis de tráfego. Quando isso acontecer, recomendamos que você tente novamente sua solicitação com backoff exponencial. No caso de um incidente ou interrupção, a Braze não poderá reproduzir nenhuma chamada à API REST que tenha falhado durante a janela do incidente. Você precisará tentar novamente todas as chamadas que falharam durante a janela do incidente.

Erros fatais

Os códigos de status a seguir e as mensagens de erro associadas serão retornados se sua solicitação encontrar um erro fatal.