Tratamento de erros

Visão geral overview

Os erros de API na API do servidor do Adobe Experience Platform Edge Network podem ter várias causas: internas (Edge Network em si) ou externas (relacionadas a entrada, configuração ou upstream).

Tipos de erro error-types

Severidade

Os erros da API do servidor também podem ser divididos por gravidade:

Erros fatais fatal-errors

Erros fatais interrompem o processamento de solicitações e fazem com que um status de resposta não 2xx seja retornado. Confira a seção tipos de erro para ver o código de status esperado, correspondente a cada tipo de erro.

Os erros serão acompanhados por um corpo de resposta contendo um objeto de erro. Nesse caso, o corpo da resposta contém um detalhe de problema, conforme definido por RFC 7807 Detalhes de Problema para APIs HTTP.

O tipo de conteúdo retornado é o tipo de mídia application/problem+json. Quando presente, essa resposta contém detalhes legíveis por máquina relacionados ao erro. Os detalhes do problema incluem um tipo de URI.

Todos os objetos de erro têm propriedades de mensagem type, status, title, detail e report para que o cliente da API possa informar qual é o problema.

{
   "type":"https://ns.adobe.com/aep/errors/EXEG-0104-422",
   "status":422,
   "title":"Unprocessable entity",
   "detail":"Invalid request (report attached). Please check your input and try again.",
   "report":{
      "errors":[
         "Allowed Adobe version is 1.0 for standard 'Adobe' at index 0",
         "Allowed IAB version is 2.0 for standard 'IAB TCF' at index 1",
         "IAB consent string value must not be empty for standard 'IAB TCF' at index 1"
      ],
      "requestId":"0f8821e5-ed1a-4301-b445-5f336fb50ee8",
      "orgId":"53A16ACB5CC1D3760A495C99@AdobeOrg"
   }
}

Erros não fatais non-fatal-errors

Os erros não fatais podem ser ainda divididos em:

Ao encontrar erros não fatais (excluindo avisos), o Server API alterará o status da resposta para 207 Multi-Status.

Por outro lado, os avisos são na sua maioria informativos, uma vez que representam geralmente uma condição potencialmente transitória, que não afetou totalmente o pedido. Um exemplo aqui é uma leitura parcial de perfil no mecanismo de segmentação, nesse caso, a precisão é afetada em algum grau, mas a funcionalidade ainda é fornecida.

Os erros não fatais são representados no formato Detalhes do Problema, mas são inseridos diretamente na resposta padrão do gateway do Edge, que é do tipo application/json.

{
  "requestId": "72eaa048-207e-4dde-bf16-0cb2b21336d5",
  "handle": [
  ],
  "errors": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0201-503",
      "status": 503,
      "title": "The 'com.adobe.experience.platform.ode' service is temporarily unable to serve this request. Please try again later."
    }
  ],
  "warnings": [
    {
      "type": "https://ns.adobe.com/aep/errors/EXEG-0204-200",
      "status": 200,
      "title": "A warning occurred while calling the 'com.adobe.audiencemanager' service for this request.",
      "report": {
        "cause": {
          "message": "Cannot read related customer for device id: ...",
          "code": 202
        }
      }
    }
  ]
}

Manipulando 4xx e 5xx Respostas