Gestione degli errori

Panoramica overview

Gli errori API nell’API Adobe Experience Platform Edge Network Server possono avere diverse cause, interne (Edge Network stesso) o esterne (correlate all’input, alla configurazione o a monte).

Tipi di errore error-types

Gravità

Gli errori API server possono essere suddivisi anche in base alla gravità:

Errori irreversibili fatal-errors

Errori irreversibili interrompono l’elaborazione della richiesta e causano la restituzione di uno stato di risposta non 2xx. Consulta la sezione tipi di errore per visualizzare il codice di stato previsto, corrispondente a ciascun tipo di errore.

Gli errori saranno accompagnati da un corpo della risposta contenente un oggetto di errore. In questo caso, il corpo della risposta contiene un dettaglio del problema, come definito da RFC 7807 Problem Details for HTTP APIs.

Il tipo di contenuto restituito è il tipo di supporto application/problem+json. Se presente, questa risposta contiene dettagli leggibili dal computer relativi all’errore. I dettagli del problema includono un tipo URI.

Tutti gli oggetti errore hanno proprietà di messaggio type, status, title, detail e report in modo che il client API possa individuare il 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"
   }
}

Errori non irreversibili non-fatal-errors

Gli errori non irreversibili possono essere ulteriormente suddivisi in:

Quando si verificano errori non irreversibili (esclusi gli avvisi), Server API cambierà lo stato della risposta in 207 Multi-Status.

Le avvertenze, d’altro canto, sono per lo più informative, in quanto in genere rappresentano una condizione potenzialmente transitoria che non ha avuto un impatto completo sulla richiesta. Un esempio di questo è un profilo parziale letto nel motore di segmentazione, nel qual caso la precisione è influenzata in qualche misura, ma la funzionalità è ancora disponibile.

Gli errori non irreversibili sono rappresentati nel formato Dettagli problema, ma sono incorporati direttamente nella risposta standard del gateway Edge, che è di 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
        }
      }
    }
  ]
}

Gestione di 4xx e 5xx risposte