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 da Braze e como solucioná-los.

Respostas do servidor

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

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

Observe que sucesso significa apenas que a carga útil da API RESTful foi corretamente formada e passada para nossos serviços de 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 a entrega da mensagem (por exemplo, um dispositivo pode estar offline, o token por push pode ser rejeitado pelos servidores da Apple, ou você pode ter fornecido um ID de usuário desconhecido).

Para endpoints como /users/identify, que não enviam mensagens, uma mensagem de sucesso significa apenas que a Braze recebeu a solicitação para processamento. Se não houver correspondência para o alias após o processamento, a solicitação é interrompida.

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>]
}

No caso de sucesso, quaisquer mensagens que não foram afetadas por um erro no array errors ainda sã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 rastreados

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 broadcast. Quando o rastreamento estiver disponível para uma instância de envio de campanha específica, você receberá a seguinte resposta:

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

O ID de envio fornecido pode ser usado como parâmetro para o endpoint /send/data_series para obter análises de dados específicas do 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 o período do incidente. Você deve tentar novamente quaisquer chamadas que falharam durante o período do incidente.
  • Um erro 502 é uma falha antes de chegar ao servidor de destino.
  • Um erro 503 significa que a solicitação chegou ao servidor de destino, mas não foi possível completá-la porque não há capacidade suficiente, ou há um problema de rede, ou similar.
  • Um erro 504 indica que um servidor não recebeu uma resposta de outro servidor upstream.

Erros fatais

Os seguintes códigos de status e mensagens de erro associadas são retornados se sua solicitação encontrar um erro fatal.