Codici di errore migliorati enhanced-error-codes
I codici di errore avanzati rappresentano una funzione di autenticazione di Adobe Pass che fornisce informazioni aggiuntive sugli errori alle applicazioni client integrate con:
-
API REST di autenticazione Adobe Pass:
-
API di preautorizzazione SDK per autenticazione Adobe Pass:
- JavaScript SDK (API di preautorizzazione)
- SDK iOS/tvOS (API di preautorizzazione)
- SDK di Android (API di preautorizzazione)
(*) L'API di preautorizzazione è l'unica API SDK di autenticazione di Adobe Pass che fornisce supporto per codici di errore avanzati.
Rappresentazione enhanced-error-codes-representation
I codici di errore avanzati possono essere rappresentati nel formato JSON
o XML
a seconda dell'API di autenticazione Adobe Pass integrata e del valore di intestazione "Accept" utilizzato (ad esempio application/json
o application/xml
):
- Informazioni sull'errore di primo livello: in questo caso, l'oggetto "error" si trova di primo livello, pertanto il corpo della risposta può contenere solo l'oggetto "error".
- Informazioni sull'errore a livello di elemento: in questo caso, l'oggetto "error" si trova a livello di elemento, pertanto il corpo della risposta può contenere un oggetto "error" per tutti gli elementi che hanno riscontrato un errore durante la manutenzione.
Fare riferimento alle seguenti risposte HTTP contenenti esempi di codici di errore avanzati rappresentati come JSON
o XML
.
code language-json |
---|
|
code language-xml |
---|
|
code language-json |
---|
|
code language-json |
---|
|
code language-json |
---|
|
I codici di errore avanzati includono i seguenti campi JSON
o attributi XML
:
Per ulteriori dettagli, consulta la sezione Azione.
Per ulteriori dettagli, consulta la sezione Codice.
Per ulteriori dettagli, consulta la sezione Gestione delle risposte.
Questo campo potrebbe non essere presente nel caso in cui il partner di servizi non fornisca alcun messaggio personalizzato.
Questo campo contiene un URL assoluto e non deve essere dedotto dal codice di errore, a seconda del contesto di errore è possibile fornire un URL diverso.
Azione enhanced-error-codes-representation-action
I codici di errore avanzati includono un campo "action" che fornisce un’azione consigliata che potrebbe risolvere la situazione.
I valori possibili per il campo "azione" includono:
(*) Per alcuni errori, potrebbero essere possibili più azioni, ma il campo "action" indica quella con la maggiore probabilità di correggere l'errore.
Stato enhanced-error-codes-representation-status
I codici di errore avanzati includono un campo "status" che indica il codice di stato HTTP associato all’errore.
I valori possibili per il campo "status" includono:
Codici di errore migliorati con uno "stato" 4xx vengono in genere visualizzati quando l’errore viene generato dal client e la maggior parte delle volte implica che il client richiede un lavoro aggiuntivo per correggerlo.
Codici di errore migliorati con uno "stato" 5xx vengono in genere visualizzati quando l’errore viene generato dal server e la maggior parte delle volte implica che il server richiede un lavoro aggiuntivo per correggerlo.
Codice enhanced-error-codes-representation-code
I codici di errore avanzati includono un campo "code" che fornisce un identificatore univoco di autenticazione Adobe Pass associato all’errore.
I valori possibili per il campo "code" sono aggregati di seguito in due elenchi basati sull'API di autenticazione Adobe Pass integrata.
Elenchi enhanced-error-codes-lists
API REST v1 enhanced-error-codes-lists-rest-api-v1
La tabella seguente elenca i possibili codici di errore avanzati che un’applicazione client potrebbe incontrare quando integrata con l’API REST di autenticazione di Adobe Pass v1.
API di pre-autorizzazione SDK enhanced-error-codes-lists-sdks-preauthorize-api
Consulta la sezione precedente per informazioni sui possibili codici di errore avanzati che un'applicazione client potrebbe incontrare quando integrata con l'API di preautorizzazione degli SDK di autenticazione di Adobe Pass.
API REST v2 enhanced-error-codes-lists-rest-api-v2
La tabella seguente elenca i possibili codici di errore avanzati che un’applicazione client potrebbe incontrare quando integrata con l’API REST di autenticazione di Adobe Pass v2.
Gestione della risposta enhanced-error-codes-response-handling
In sintesi, quando gestisci le risposte contenenti codici di errore avanzati, prendi in considerazione quanto segue:
-
Verifica entrambi i valori di stato: controlla sempre sia il codice di stato della risposta HTTP che il campo "stato" del codice di errore avanzato. Potrebbero essere diversi ed entrambi forniscono informazioni preziose.
-
Informazioni di errore di livello principale e di livello elemento: gestire le informazioni di errore di livello principale e di livello elemento indipendentemente dal modo in cui vengono comunicate, assicurarsi di poter gestire entrambe le forme di trasmissione dei codici di errore avanzati.
-
Logica tentativi: per gli errori che richiedono un nuovo tentativo, assicurati che i nuovi tentativi vengano eseguiti con un backoff esponenziale per evitare di sopraffare il server. Inoltre, nel caso di API di autenticazione di Adobe Pass che gestiscono più elementi contemporaneamente (ad esempio, API di preautorizzazione), devi includere nella richiesta ripetuta solo gli elementi contrassegnati con "riprova" e non l’intero elenco.
-
Modifiche alla configurazione: per gli errori che richiedono modifiche alla configurazione, verificare che le modifiche necessarie siano state apportate prima di avviare la nuova applicazione o la nuova funzionalità.
-
Autenticazione e autorizzazione: per gli errori relativi all'autenticazione e all'autorizzazione, è necessario richiedere all'utente di ripetere l'autenticazione o ottenere una nuova autorizzazione in base alle esigenze.
-
Feedback utente: facoltativo, utilizzare i campi "messaggio" e (potenziali) "dettagli" leggibili per informare l'utente del problema. Il messaggio di testo "details" (Dettagli) potrebbe essere trasmesso dagli endpoint di preautorizzazione o autorizzazione MVPD o dal Programmatore quando si applicano regole di degradazione.