Verbeterde foutcodes enhanced-error-codes
Enhanced Error Codes vertegenwoordigen een Adobe Pass-verificatiefunctie die aanvullende foutinformatie biedt voor clienttoepassingen die zijn geïntegreerd met:
-
Adobe Pass-verificatie REST-API's:
-
Adobe Pass-verificatie-SDK's autoriseren-API:
- JavaScript SDK (API voor voorafgaande autorisatie)
- iOS/tvOS SDK (API vooraf autoriseren)
- Android SDK (API voor voorafgaande autorisatie)
(*) Vooraf autoriseren API is de enige Adobe Pass Authentication SDK API die ondersteuning biedt voor Enhanced Error Codes.
Vertegenwoordiging enhanced-error-codes-representation
Enhanced Error Codes kunnen worden weergegeven in de JSON
- of XML
-indeling, afhankelijk van de geïntegreerde Adobe Pass Authentication API en de gebruikte headerwaarde Accept (d.w.z. application/json
of application/xml
):
- Top-level fouteninformatie: In dit geval, wordt het "fout" voorwerp gevestigd op het hoogste niveau, daarom kan het antwoordlichaam slechts het "fout" voorwerp bevatten.
- punt-vlakke fouteninformatie: In dit geval, wordt het "fout" voorwerp gevestigd op het puntenniveau, daarom kan het antwoordlichaam een "fout" voorwerp voor alle punten bevatten die een fout terwijl het worden onderhouden ervaren.
Raadpleeg de volgende HTTP-reacties met voorbeelden van uitgebreide foutcodes die worden weergegeven als JSON
of XML
.
code language-json |
---|
|
code language-xml |
---|
|
code language-json |
---|
|
code language-json |
---|
|
code language-json |
---|
|
Uitgebreide foutcodes bevatten de volgende JSON
velden of XML
kenmerken:
voor meer details, verwijs naar de sectie van de Actie.
voor meer details, verwijs naar de 2} sectie van de Status {.
voor meer details, verwijs naar de sectie van de Code.
voor meer details, verwijs naar de Behandeling van de Reactiesectie.
Dit gebied zou niet aanwezig kunnen zijn voor het geval de de dienstenpartner geen douanebericht verstrekt.
Dit veld bevat een absolute URL en mag niet worden afgeleid van foutcode, afhankelijk van de foutcontext kan een andere URL worden opgegeven.
Handeling enhanced-error-codes-representation-action
De uitgebreide foutcodes bevatten een veld "Handeling" met een aanbevolen handeling die de situatie zou kunnen verhelpen.
De mogelijke waarden voor het veld "Handeling" zijn:
(*) Voor sommige fouten, zouden de veelvoudige acties mogelijke oplossingen kunnen zijn, maar het gebied van de "actie"wijst met de hoogste waarschijnlijkheid aan om de fout te bevestigen.
Status enhanced-error-codes-representation-status
Uitgebreide foutcodes bevatten een veld "status" dat de HTTP-statuscode aangeeft die aan de fout is gekoppeld.
De mogelijke waarden voor het veld status zijn:
Verbeterde foutcodes met een 4xx-"status" worden meestal weergegeven wanneer de fout door de client wordt gegenereerd en meestal impliceert dit dat de client extra werk nodig heeft om de fout te verhelpen.
Uitgebreide foutcodes met een "status" van 5 xx worden meestal weergegeven wanneer de fout door de server wordt gegenereerd en het grootste deel van de tijd dat dit impliceert dat de server extra werk nodig heeft om de fout te verhelpen.
Code enhanced-error-codes-representation-code
Uitgebreide foutcodes bevatten een veld "code" met een unieke id voor Adobe Pass-verificatie die aan de fout is gekoppeld.
De mogelijke waarden voor het "code"gebied worden samengevoegd hieronderin twee lijsten die op de geïntegreerde Authentificatie API van Adobe Pass worden gebaseerd.
Lijsten enhanced-error-codes-lists
REST API v1 enhanced-error-codes-lists-rest-api-v1
In de onderstaande tabel worden mogelijke Enhanced Error Codes weergegeven die een clienttoepassing kan tegenkomen bij integratie met Adobe Pass Authentication REST API v1.
API voor voorafgaande autorisatie van SDK's enhanced-error-codes-lists-sdks-preauthorize-api
Verwijs naar de vorige sectievoor mogelijke Verbeterde Codes van de Fout een cliënttoepassing zou kunnen ontmoeten wanneer geïntegreerd met de Authentificatie SDKs van Adobe Pass preauthorize API.
REST API v2 enhanced-error-codes-lists-rest-api-v2
In de onderstaande tabel worden mogelijke Enhanced Error Codes weergegeven die een clienttoepassing kan tegenkomen bij integratie met Adobe Pass Authentication REST API v2.
Reactieafhandeling enhanced-error-codes-response-handling
Samenvattend, wanneer het behandelen van reacties die de Geavanceerde Codes van de Fout bevatten, zou u het volgende moeten overwegen:
-
Controle beide statuswaarden: Controleer altijd zowel de code van de de reactiestatus van HTTP als het Verbeterde gebied van de Code van de Fout "status". Ze kunnen verschillen en beide bieden waardevolle informatie.
-
Agnostisch aan top-level versus punt-niveau fouteninformatie: Behandel top-level en punt-vlakke fouteninformatie agnostisch aan de manier het wordt meegedeeld, zorg ervoor u beide vormen van het overbrengen van de Verbeterde Codes van de Fout kunt behandelen.
-
probeert logica opnieuw: Voor fouten die een herpoging vereisen, zorg ervoor dat de pogingen met exponentiële backoff worden gedaan om het overweldigen van de server te vermijden. In het geval van Adobe Pass Authentication API's die meerdere items tegelijk verwerken (bijvoorbeeld API vooraf autoriseren), moet u in de herhaalde aanvraag ook alleen die items opnemen die zijn gemarkeerd met "retry" en niet de volledige lijst.
-
de veranderingen van de Configuratie: Voor fouten die configuratieveranderingen vereisen, zorg ervoor dat de noodzakelijke veranderingen worden aangebracht alvorens de nieuwe toepassing of de nieuwe eigenschap te lanceren.
-
Authentificatie en vergunning: Voor fouten met betrekking tot authentificatie en vergunning, moet u de gebruiker ertoe aanzetten opnieuw voor authentiek te verklaren of nieuwe vergunning te verkrijgen zoals nodig.
-
Gebruiker terugkoppelt: Facultatief, gebruik het mens-leesbare "bericht"en (potentiële) "details"gebieden om de gebruiker over de kwestie te informeren. Het "details"tekstbericht zou van MVPD kunnen worden overgegaan pre- of toestemmingseindpunten of van de Programmer wanneer het toepassen van degradatieregels.