Page d’enregistrement (héritée) registration-page
Points d’entrée de l’API REST clientless-endpoints
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.
NOTE
L’implémentation de l’API REST est limitée par mécanisme de limitation
<REGGIE_FQDN> :
- Production - api.auth.adobe.com
- Évaluation - api.auth-staging.adobe.com
<SP_FQDN> :
- Production - api.auth.adobe.com
- Évaluation - api.auth-staging.adobe.com
Description create-reg-code-svc
Renvoie le code d’enregistrement et l’URI de page de connexion générés de manière aléatoire.
Point d’entrée
Appelé
Par
Par
Entrée
Paramètre
Paramètre
HTTP
Méthode
Méthode
Réponse
HTTP
Réponse
Réponse
<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
Par exemple :
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
Par exemple :
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode
Service de programmation
ou
d’application en flux continu
ou
d’application en flux continu
1.
du demandeur (Composant Chemin d’accès)
2. deviceId (haché)
(Obligatoire)
3. device_info/X-Device-Info (obligatoire)
4. mvpd (facultatif)
5. ttl (facultatif)
du demandeur (Composant Chemin d’accès)
2. deviceId (haché)
(Obligatoire)
3. device_info/X-Device-Info (obligatoire)
4. mvpd (facultatif)
5. ttl (facultatif)
POST
XML ou JSON contenant un code d’enregistrement et des informations ou des détails d’erreur en cas d’échec. Voir les exemples ci-dessous.
201
Paramètre d’entrée
Type
Description
Autorisation
En-tête
valeur : porteur <access_token>
valeur : porteur <access_token>
Jeton d’accès DCR
Accepter
Valeur de
d’en-tête : application/json.
d’en-tête : application/json.
indiquer le type de contenu que le client doit pouvoir comprendre
demandeur
Paramètre de requête
ID de demandeur du programmeur pour lequel cette opération est valide.
deviceId
Paramètre de requête
Octets d’ID de l’appareil.
device_info/
X-Device-Info
X-Device-Info
device_info : Corps
X-Device-Info : En-tête
X-Device-Info : En-tête
Informations sur l’appareil de diffusion en continu.
Remarque : cela PEUT être transmis à device_info en tant que paramètre d’URL, mais en raison de la taille potentielle de ce paramètre et des limitations de la longueur d’une URL de GET, il DOIT être transmis en tant que X-Device-Info dans l’en-tête http.
Voir les détails complets dans Transmettre les informations sur l’appareil et la connexion.
Remarque : cela PEUT être transmis à device_info en tant que paramètre d’URL, mais en raison de la taille potentielle de ce paramètre et des limitations de la longueur d’une URL de GET, il DOIT être transmis en tant que X-Device-Info dans l’en-tête http.
Voir les détails complets dans Transmettre les informations sur l’appareil et la connexion.
mvpd
Paramètre de requête
Identifiant MVPD pour lequel cette opération est valide.
ttl
Paramètre de requête
Durée pendant laquelle ce regcode doit durer en secondes.
Remarque : la valeur maximale autorisée pour ttl est de 36000 secondes (10 heures). Des valeurs plus élevées entraînent une réponse HTTP 400 (requête incorrecte). Si
Remarque : la valeur maximale autorisée pour ttl est de 36000 secondes (10 heures). Des valeurs plus élevées entraînent une réponse HTTP 400 (requête incorrecte). Si
ttl
n’est pas renseigné, l’authentification Adobe Pass définit une valeur par défaut de 30 minutes.deviceType
Paramètre de requête
Obsolète, ne doit pas être utilisé.
deviceUser
Paramètre de requête
Obsolète, ne doit pas être utilisé.
appId
Paramètre de requête
Obsolète, ne doit pas être utilisé.
CAUTION
Adresse IP de l’appareil de streaming
Pour les implémentations client à serveur, l’adresse IP de l’appareil de diffusion en continu est implicitement envoyée avec cet appel. Pour les implémentations serveur à serveur, où l’appel regcode est effectué par le service de programmation et non par l’appareil de diffusion en continu, l’en-tête suivant est requis pour transmettre l’adresse IP de l’appareil de diffusion en continu :
Pour les implémentations client à serveur, l’adresse IP de l’appareil de diffusion en continu est implicitement envoyée avec cet appel. Pour les implémentations serveur à serveur, où l’appel regcode est effectué par le service de programmation et non par l’appareil de diffusion en continu, l’en-tête suivant est requis pour transmettre l’adresse IP de l’appareil de diffusion en continu :
code language-none |
---|
|
où
Exemple :
<streaming\_device\_ip>
est l’adresse IP publique de l’appareil de diffusion en continu.Exemple :
code language-none |
---|
|
JSON de réponse
EXEMPLES JSON de code d’enregistrement
{
"id": "ef5a79e8-7c8a-41d6-a45a-e378c6c7c8b5",
"code": "IYQD5JQ",
"requestor": "sampleRequestorId",
"mvpd": "sampleMvpdId",
"generated": 1704963921144,
"expires": 1704965721144,
"info": {
"deviceId": "c28tZGV2aWQtMDAz",
"deviceInfo": "eyJ0eXBlIjoiU2V0VG9wQm94IiwibW9kZWwiOiJBRlRNTSIsInZlcnNpb24iOnsibWFqb3IiOjAsIm1pbm9yIjowLCJwYXRjaCI6MCwicHJvZmlsZSI6IiJ9LCJoYXJkd2FyZSI6eyJuYW1lIjoiQUZUTU0iLCJ2ZW5kb3IiOiJVbmtub3duIiwidmVyc2lvbiI6eyJtYWpvciI6MCwibWlub3IiOjAsInBhdGNoIjowLCJwcm9maWxlIjoiIn0sIm1hbnVmYWN0dXJlciI6IlJva3UifSwib3BlcmF0aW5nU3lzdGVtIjp7Im5hbWUiOiJBbmRyb2lkIiwiZmFtaWx5IjoiQW5kcm9pZCIsInZlbmRvciI6IkFtYXpvbiIsInZlcnNpb24iOnsibWFqb3IiOjcsIm1pbm9yIjoxLCJwYXRjaCI6MiwicHJvZmlsZSI6IiJ9fSwiYnJvd3NlciI6eyJuYW1lIjoiQ2hyb21lIiwidmVuZG9yIjoiR29vZ2xlIiwidmVyc2lvbiI6eyJtYWpvciI6MTEyLCJtaW5vciI6MCwicGF0Y2giOjU2MTUsInByb2ZpbGUiOiIifSwidXNlckFnZW50IjoiTW96aWxsYS81LjAgKExpbnV4OyBBbmRyb2lkIDcuMS4yOyBBRlRNTSBCdWlsZC9OUzYyOTc7IHd2KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBWZXJzaW9uLzQuMCBDaHJvbWUvMTEyLjAuNTYxNS4xOTcgTW9iaWxlIFNhZmFyaS81MzcuMzYgQWRvYmVQYXNzTmF0aXZlRmlyZVRWLzMuMC44Iiwib3JpZ2luYWxVc2VyQWdlbnQiOiJNb3ppbGxhLzUuMCAoTGludXg7IEFuZHJvaWQgNy4xLjI7IEFGVE1NIEJ1aWxkL05TNjI5Nzsgd3YpIEFwcGxlV2ViS2l0LzUzNy4zNiAoS0hUTUwsIGxpa2UgR2Vja28pIFZlcnNpb24vNC4wIENocm9tZS8xMTIuMC41NjE1LjE5NyBNb2JpbGUgU2FmYXJpLzUzNy4zNiBBZG9iZVBhc3NOYXRpdmVGaXJlVFYvMy4wLjgifSwiZGlzcGxheSI6eyJ3aWR0aCI6MCwiaGVpZ2h0IjowLCJwcGkiOjAsIm5hbWUiOiJESVNQTEFZIiwidmVuZG9yIjpudWxsLCJ2ZXJzaW9uIjpudWxsLCJkaWFnb25hbFNpemUiOm51bGx9LCJhcHBsaWNhdGlvbklkIjpudWxsLCJjb25uZWN0aW9uIjp7ImlwQWRkcmVzcyI6IjE5My4xMDUuMTQwLjEzMSIsInBvcnQiOiI5OTM0Iiwic2VjdXJlIjpmYWxzZSwidHlwZSI6bnVsbH19",
"userAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
"originalUserAgent": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6297; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/112.0.5615.197 Mobile Safari/537.36 AdobePassNativeFireTV/3.0.8",
"authorizationType": "OAUTH2",
"sourceApplicationInformation": {
"id": "14138364-application-id",
"name": "application name",
"version": "1.0.0"
}
}
}
Nom de l’élément
Description
id
UUID généré par le service de code d’enregistrement
code
Code d’enregistrement généré par le service Registration Code
demandeur
ID du demandeur
mvpd
Identifiant Mvpd
généré
Date et heure de création du code d’enregistrement (en millisecondes depuis le 1er janvier 1970 GMT)
expire
Date et heure d’expiration du code d’enregistrement (en millisecondes depuis le 1er janvier 1970 GMT)
deviceId
ID d’appareil unique Base64
info:deviceId
Type d’appareil Base64
info:deviceInfo
Base64 Normalised Device Information s'appuie sur les informations reçues de User-Agent, X-Device-Info ou device_info
info:userAgent
Agent utilisateur envoyé par l’application
info:originalUserAgent
Agent utilisateur envoyé par l’application
info:authorizationType
OAUTH2 des appels à l’aide de DCR
info:sourceApplicationInformation
Informations sur l’application telles que configurées dans le DCR
Exemple de réponse JSON de message d’erreur (#error-sample-response)
{
"status": 400,
"message": "Required '<>' is not present"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b