(Hérité) Lancer l’autorisation initiate-authorization

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

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

<REGGIE_FQDN> :

<SP_FQDN> :

Description description

Obtient la réponse d’autorisation.

Point d’entrée
Appelé
Par
Entrée
Params
HTTP
Méthode
Réponse
HTTP
Réponse
<SP_FQDN>/api/v1/authorize.
Service de programmation

ou

d’application en flux continu
1. demandeur (obligatoire)
2. deviceId (obligatoire)
3. ressource (obligatoire)
4. device_info/X-Device-Info (obligatoire)
5. deviceType
6 deviceUser (obsolète)
7. appId (obsolète)
8. paramètres supplémentaires (facultatif)
GET
XML ou JSON contenant les détails d’autorisation ou les détails d’erreur en cas d’échec. Voir les exemples ci-dessous.
200 - Succès
403 - Aucun Succès
Paramètre d’entrée
Description
demandeur
ID de demandeur du programmeur pour lequel cette opération est valide.
deviceId
Octets d’ID de l’appareil.
ressource
Chaîne contenant un resourceId (ou un fragment MRSS), identifiant le contenu demandé par un utilisateur et reconnu par les points d’entrée d’autorisation MVPD.
device_info/

X-Device-Info
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.
deviceType
Type d’appareil (par exemple Roku, PC).

Si ce paramètre est défini correctement, ESM propose des mesures ventilées par type d’appareil lors de l’utilisation de Clientless, de sorte que différents types d’analyse puissent être effectués pour Roku, AppleTV, Xbox, etc.

Voir Avantages du paramètre de type d’appareil sans client dans les mesures de réussite

Remarque : device_info remplacera ce paramètre.
deviceUser
Identifiant utilisateur de l’appareil.
appId
Nom/ID de l’application.

Remarque : device_info remplace ce paramètre.
paramètres supplémentaires
L’appel peut également contenir des paramètres facultatifs qui activent d’autres fonctionnalités telles que :

* generic_data - permet l’utilisation de Promotional TempPass

Exemple : generic_data=("email":"email@domain.com")
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
code language-none
X-Forwarded-For : <streaming\_device\_ip>
<streaming\_device\_ip> est l’adresse IP publique de l’appareil de diffusion en continu.


Exemple :
code language-none
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

Exemple de réponse sample-response

  • Cas 1 : Succès

    • XML:

    « XML
    <?xml version=« 1.0 » encoding=« UTF-8 » standalone=« yes »?>
    <authorization>
    <expires>1348148289000</expires>
    <mvpd>sampleMvpdId</mvpd>
    <requestor>sampleRequestorId</requestor>
    <resource>sampleResourceId</resource>
    </authorization>
    »

  • JSON:

    code language-json
    {
      "mvpd": "sampleMvpdId",
      "resource": "sampleResourceId",
      "requestor": "sampleRequestorId",
      "expires": "1348148289000"
    }
    
IMPORTANT
Lorsque la réponse provient d’un MVPD proxy, elle peut inclure un élément supplémentaire nommé proxyMvpd.
  • Cas 2 : autorisation refusée

    code language-json
    <error>
      <status>403</status>
      <message>User not authorized</message>
      <details>Your subscription package does not include the "ASFAFD" channel.
      Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details>
    </error>
    
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b