Referencia de API de REST rest-api-reference

NOTE
El contenido de esta página se proporciona únicamente con fines informativos. El uso de esta API requiere una licencia actual de Adobe. No se permite el uso no autorizado.

Mecanismo de limitación

La API de REST de autenticación de Adobe Pass se rige por un Mecanismo de limitación.

Formatos de respuesta response-formats

NOTE
Las API proporcionadas en estos servicios pueden devolver respuestas en XML o JSON (para API que devuelven una respuesta). Existen tres formas diferentes de especificar el formato de respuesta en la solicitud:
  • Definir encabezado Aceptar HTTP en application/xml o application/json.
  • En la carga útil de la solicitud, especifique el parámetro format=xml o format=json.
  • Llamar al extremo del servicio web con la extensión .xml o .json. Por ejemplo, /regcode.xml o /regcode.json
Puede especificar cualquiera de los métodos anteriores. La especificación de varios métodos con formatos conflictivos puede dar lugar a errores o a resultados no deseados.

Extremos de API de REST clientless-endpoints

<reggie_fqdn>:

<sp_fqdn>:

Resumen de servicios web web_srvs_summary

En la tabla siguiente se enumeran los servicios web disponibles para el enfoque sin cliente. Haga clic en los extremos de los servicios web para obtener más información (solicitud y respuesta de ejemplo, parámetros de entrada, métodos HTTP, etc.).

Sr
Punto final de servicio web
Descripción
.
Alojado en
Llamado por
1.
<reggie_fqdn>/reggie/v1/
{requestorId}/regcode
Devuelve el código de registro generado aleatoriamente y el URI de la página de inicio de sesión
2
Adobe
Servicio de código de registro
Smart Device
2.
<reggie_fqdn>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Devuelve el registro del código de registro que contiene el UUID del código de registro, el código de registro y el ID del dispositivo con hash
8
Adobe
Servicio de código de registro
Adobe Pass Authentication
3.
<sp_fqdn>/api/v1/config/
{requestorId}
Devuelve la lista de MVPD configuradas para el solicitante
5
Adobe
Adobe Pass
authentication
Servicio
Iniciar sesión
Web
Aplicación
4.
<sp_fqdn>/api/v1/authenticate
Inicia el proceso AuthN al informar al evento de selección de MVPD. Crea un registro en la base de datos de autenticación, que se concilia cuando se recibe una respuesta correcta de MVPD (Paso 13)
7
Adobe
Adobe Pass
authentication
Servicio
Iniciar sesión
Web
Aplicación
5.
Consumidor de afirmación de SAML
Flujo de trabajo SAML existente entre Adobe Pass Authentication y MVPD
13
Adobe Pass
authentication
Servicio
Adobe Pass Authentication
6.
<sp_fqdn>/api/v1/checkauthn/
{registrationCode}
La aplicación web de inicio de sesión puede comprobar si el flujo de inicio de sesión intentado se ha realizado correctamente
Adobe Pass
authentication
Servicio
Iniciar sesión
Web
Aplicación
7.
<sp_fqdn>/api/v1/tokens/authn
Obtiene metadatos relacionados con el token de AuthN
15
Adobe Pass
authentication
Servicio
Smart Device
8.
<reggie_fqdn>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Elimina el registro de código reg y libera el código reg para su reutilización
16
Adobe
Servicio de código de registro
Adobe Pass Authentication
9.
<sp_fqdn>/api/v1/authorize
Obtiene una respuesta de autorización.
17
Adobe Pass
authentication
Servicio
Smart Device
10.
<sp_fqdn>/api/v1/checkauthn
Indica si el dispositivo tiene un token de AuthN no caducado.
Adobe Pass
authentication
Servicio
Smart Device
11.
<sp_fqdn>/api/v1/tokens/authn
Devuelve el token de AuthN si se encuentra.
Adobe Pass
authentication
Servicio
Smart Device
12.
<sp_fqdn>/api/v1/tokens/authz
Devuelve el token de AuthZ si se encuentra.
Adobe Pass
authentication
Servicio
Smart Device
13.
<sp_fqdn>/api/v1/tokens/media
Devuelve el token de medio corto si se encuentra, igual que /api/v1/mediatoken
Adobe Pass
authentication
Servicio
Smart Device
14.
<sp_fqdn>/api/v1/mediatoken
Obtiene el token de medios corto
Adobe Pass
authentication
Servicio
Smart Device
15.
<sp_fqdn>/api/v1/preauthorize
Recupera la lista de recursos preautorizados
Adobe Pass
authentication
Servicio
Smart Device
16.
<sp_fqdn>/api/v1/preauthorize/{code}
Recupera la lista de recursos preautorizados
Adobe Pass
authentication
Servicio
Iniciar sesión en aplicación web
17.
<sp_fqdn>/api/v1/logout
Quitar los tokens AuthN y AuthZ del almacenamiento
Adobe Pass
authentication
Servicio
Smart Device
18.
<sp_fqdn>/api/v1/tokens/usermetadata
Obtiene metadatos de usuario una vez completado el flujo de autenticación
N/D
N/D
Smart Device
19.
<sp_fqdn>/api/v1/authenticate/freepreview
Crear un token de autenticación para Pase temporal o Pase temporal promocional
N/D
Adobe Pass
authentication
Servicio
Smart Device

Seguridad de API de REST security

Todas las API sin cliente de autenticación de Adobe Pass deben llamarse usando el protocolo HTTPS para una comunicación segura. Además, la mayoría de las API llamadas a debe contener un token de acceso proporcionado por Registro dinámico de clientes.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b