Référence de l’API REST (héritée) rest-api-reference

NOTE
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence Adobe. Aucune utilisation non autorisée n’est autorisée.
IMPORTANT
Veillez à rester informé des dernières annonces de produits Authentification Adobe Pass et des délais de désactivation agrégés dans la page Annonces de produits.

Mécanisme de limitation

L’API REST d’authentification Adobe Pass est régie par un mécanisme de limitation.

Formats de réponse response-formats

NOTE
Les API fournies dans ces services peuvent renvoyer des réponses au format XML ou JSON (pour les API qui renvoient une réponse). Il existe trois manières différentes de spécifier le format de réponse dans la requête :
  • Définissez l’en-tête HTTP Accept sur application/xml ou application/json.
  • Dans la payload de la requête, spécifiez le paramètre format=xml ou format=json.
  • Appelez le point d’entrée du service web avec l’extension .xml ou .json. Par exemple, /regcode.xml ou /regcode.json
Vous pouvez spécifier l’une des méthodes ci-dessus. La spécification de plusieurs méthodes avec des formats en conflit peut entraîner des erreurs ou une sortie indésirable.

Points d’entrée de l’API REST clientless-endpoints

<REGGIE_FQDN> :

<SP_FQDN> :

Résumé des services web web_srvs_summary

Le tableau ci-dessous répertorie les services web disponibles pour l’approche sans client. Cliquez sur les points d’entrée des services web pour plus d’informations (exemple de requête et de réponse, paramètres d’entrée, méthodes HTTP, etc.)

Sr
Point d’entrée de service web
Description
.
Hébergé à
Appelé par
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
Renvoie le code d’enregistrement et l’URI de page de connexion générés de manière aléatoire
2
Adobe
service Reg Code
Smart Device
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Retourne l'enregistrement du code d'enregistrement contenant l'UUID du code d'enregistrement, le code d'enregistrement et l'ID de périphérique haché
8
Adobe
service Reg Code
Authentification Adobe Pass
3.
<SP_FQDN>/api/v1/config/
{requestorId}
Renvoie la liste des fichiers MVPD configurés pour le demandeur
5
Adobe
Adobe Pass
authentication
Service
Connexion
Web
App
4.
<SP_FQDN>/api/v1/authenticate
Lance le processus AuthN en informant l’événement de sélection MVPD. Crée un enregistrement sur la base de données d’authentification, qui est réconcilié lorsqu’une réponse réussie est reçue de MVPD (étape 13)
7
Adobe
Adobe Pass
authentication
Service
Connexion
Web
App
5.
Consommateur d’assertions SAML
Workflow SAML existant entre l’authentification Adobe Pass et MVPD
13
Adobe Pass
authentication
Service
Authentification Adobe Pass
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
L’application Web de connexion peut vérifier si le flux de connexion a réussi
Adobe Pass
authentification
Service
Login
Web
App
7.
<SP_FQDN>/api/v1/tokens/authn
Obtient les métadonnées liées au jeton AuthN
15
Adobe Pass
authentication
Service
Smart Device
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Supprime l’enregistrement du code rég. et libère le code rég. pour réutilisation
16
Adobe
service Reg Code
Authentification Adobe Pass
9.
<SP_FQDN>/api/v1/authorize
Obtient la réponse d’autorisation.
17
Adobe Pass
authentication
Service
Smart Device
10.
<SP_FQDN>/api/v1/checkauthn
Indique si l’appareil possède un jeton AuthN non expiré.
Adobe Pass
authentication
Service
Smart Device
11.
<SP_FQDN>/api/v1/tokens/authn
Renvoie le jeton AuthN s’il est trouvé.
Adobe Pass
authentication
Service
Smart Device
12
<SP_FQDN>/api/v1/tokens/authz
Renvoie le jeton AuthZ s’il est trouvé.
Adobe Pass
authentication
Service
Smart Device
13.
<SP_FQDN>/api/v1/tokens/media
Renvoie le jeton de média court s’il est trouvé - identique à /api/v1/mediatoken
Adobe Pass
authentication
Service
Smart Device
14.
<SP_FQDN>/api/v1/mediatoken
Obtient un jeton de média court
Adobe Pass
authentication
Service
Smart Device
15.
<SP_FQDN>/api/v1/preauthorize
Récupère la liste des ressources préautorisées
Adobe Pass
authentication
Service
Smart Device
16.
<SP_FQDN>/api/v1/preauthorize/{code}
Récupère la liste des ressources préautorisées
Adobe Pass
authentication
Service
Application Web de connexion
17.
<SP_FQDN>/api/v1/logout
Supprimer les jetons AuthN et AuthZ du stockage
Adobe Pass
authentification
Service
Smart Device
18.
<SP_FQDN>/api/v1/tokens/usermetadata
Obtient les métadonnées de l’utilisateur une fois le flux d’authentification terminé
S/O
S/O
Smart Device
19.
<SP_FQDN>/api/v1/authenticate/freepreview
Créer un jeton d’authentification pour la passe temporaire ou la passe temporaire promotionnelle
S/O
Adobe Pass
authentication
Service
Smart Device

Sécurité de l’API REST security

Toutes les API REST d’authentification Adobe Pass doivent être appelées à l’aide du protocole HTTPS pour une communication sécurisée. En outre, la plupart des API appelées doivent contenir un jeton d’accès obtenu, comme décrit dans la documentation de l’API Récupérer le jeton d’accès.

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