Códigos de error mejorados enhanced-error-codes
Los códigos de error mejorados representan una función de autenticación de Adobe Pass que proporciona información de error adicional a las aplicaciones cliente integradas con:
-
API de REST de autenticación de Adobe Pass:
-
API de preautorización de SDK de autenticación de Adobe Pass:
- SDK de JavaScript (API de preautorización)
- SDK de iOS/tvOS (API de preautorización)
- SDK de Android (API de preautorización)
(*) La API de preautorización es la única API del SDK de autenticación de Adobe Pass que admite códigos de error mejorados.
Representación enhanced-error-codes-representation
Los códigos de error mejorados se pueden representar en formato JSON
o XML
según la API de autenticación de Adobe Pass integrada y el valor de encabezado "Accept" utilizado (es decir, application/json
o application/xml
):
- Información de error de nivel superior: En este caso, el objeto "error" se encuentra en el nivel superior, por lo que el cuerpo de la respuesta solo puede contener el objeto "error".
- Información de error en el nivel de elemento: En este caso, el objeto "error" se encuentra en el nivel de elemento, por lo que el cuerpo de la respuesta puede contener un objeto "error" para todos los elementos que experimentaron un error durante el servicio.
Consulte las siguientes respuestas HTTP que contienen ejemplos de códigos de error mejorados representados como JSON
o XML
.
code language-json |
---|
|
code language-xml |
---|
|
code language-json |
---|
|
code language-json |
---|
|
code language-json |
---|
|
Los códigos de error mejorados incluyen los siguientes JSON
campos o atributos XML
:
Para obtener más información, consulte la sección Acción.
Para obtener más información, consulte la sección Código.
Para obtener más información, consulte la sección Gestión de respuestas.
Este campo podría no estar presente en caso de que el socio de servicios no proporcione ningún mensaje personalizado.
Este campo contiene una dirección URL absoluta y no debería inferirse del código de error, dependiendo del contexto de error en que se pueda proporcionar una dirección URL diferente.
Acción enhanced-error-codes-representation-action
Los códigos de error mejorados incluyen un campo "acción" que proporciona una acción recomendada que podría remediar la situación.
Los valores posibles del campo "acción" incluyen:
(*) Para algunos errores, varias acciones podrían ser posibles soluciones, pero el campo "acción" indica la que tiene la mayor probabilidad de corregir el error.
Estado enhanced-error-codes-representation-status
Los códigos de error mejorados incluyen un campo "estado" que indica el código de estado HTTP asociado al error.
Los valores posibles del campo "estado" incluyen:
Los códigos de error mejorados con un "estado" 4xx generalmente aparecen cuando el cliente genera el error y la mayoría de las veces implica que el cliente requiere trabajo adicional para corregirlo.
Los códigos de error mejorados con un "estado" 5xx generalmente aparecen cuando el servidor genera el error y la mayoría de las veces implica que el servidor requiere trabajo adicional para corregirlo.
Código enhanced-error-codes-representation-code
Los códigos de error mejorados incluyen un campo "código" que proporciona un identificador único de autenticación de Adobe Pass asociado con el error.
Los valores posibles para el campo "código" se agregan debajo de en dos listas basadas en la API de autenticación de Adobe Pass integrada.
Listas enhanced-error-codes-lists
API de REST v1 enhanced-error-codes-lists-rest-api-v1
En la tabla siguiente se enumeran los posibles códigos de error mejorados que una aplicación cliente podría encontrar al integrarse con la API de REST de autenticación de Adobe Pass v1.
API de preautorización de SDK enhanced-error-codes-lists-sdks-preauthorize-api
Consulte la sección anterior para ver los posibles códigos de error mejorados que podría encontrar una aplicación cliente al integrarse con la API de autorización previa del SDK de autenticación de Adobe Pass.
API de REST v2 enhanced-error-codes-lists-rest-api-v2
En la tabla siguiente se enumeran los posibles códigos de error mejorados que una aplicación cliente podría encontrar al integrarse con la API de REST de autenticación de Adobe Pass v2.
Gestión de respuestas enhanced-error-codes-response-handling
En resumen, al administrar respuestas que contengan códigos de error mejorados, debe tener en cuenta lo siguiente:
-
Comprobar ambos valores de estado: Compruebe siempre el código de estado de respuesta HTTP y el campo "estado" del código de error mejorado. Pueden diferir y ambos proporcionan información valiosa.
-
Información de error de nivel superior frente a nivel de elemento: administre la información de error de nivel superior y de nivel de elemento independientemente de la forma en que se comunique, asegúrese de que puede gestionar ambas formas de transmisión de códigos de error mejorados.
-
Lógica de reintento: En el caso de errores que requieran un reintento, asegúrese de que los reintentos se realicen con retroceso exponencial para evitar sobrecargar el servidor. Además, en el caso de las API de autenticación de Adobe Pass que administran varios elementos a la vez (por ejemplo, la API de preautorización), debe incluir en la solicitud repetida solo los elementos marcados con "reintentar" y no la lista completa.
-
Cambios de configuración: en el caso de errores que requieran cambios de configuración, asegúrese de realizar los cambios necesarios antes de iniciar la nueva aplicación o característica.
-
Autenticación y autorización: Para los errores relacionados con la autenticación y la autorización, debe pedir al usuario que vuelva a autenticarse u obtenga la nueva autorización según sea necesario.
-
Comentarios del usuario: como opción, use los campos de "mensaje" y "detalles" (potenciales) legibles en lenguaje natural para informar al usuario sobre el problema. El mensaje de texto "detalles" puede pasarse desde los extremos de preautorización o autorización de MVPD o desde el Programador al aplicar reglas de degradación.