Référence de l’API SDK Android (héritée)
- Rubriques :
- Authentification
NOTE
IMPORTANTIntroduction
Ce document présente les méthodes et rappels exposés par Android SDK pour l’authentification Adobe Pass, prise en charge avec Adobe Pass Authentication versions 1.7 et ultérieures. Les méthodes et fonctions de rappel décrites ici sont définies dans les fichiers d’en-tête AccessEnabler.h et EntitlementDelegate.h .
Reportez-vous à https://tve.zendesk.com/hc/en-us/articles/204963219-Android-Native-AccessEnabler-Library pour la dernière version du SDK AccessEnabler Android.
Remarque : l’équipe Authentification Adobe Pass vous incite à utiliser uniquement les API d’authentification Adobe Pass publiques :
- Les API publiques sont disponibles et entièrement testées sur tous les types de clients pris en charge. Pour toute fonctionnalité publique, nous nous assurons que chaque type de client dispose d’une version correspondante de la ou des méthodes associées.
- Les API publiques doivent être aussi stables que possible, pour prendre en charge la rétrocompatibilité et s’assurer que les intégrations des partenaires ne sont pas rompues. Toutefois, pour les API non publiques nous nous réservons le droit de modifier leur signature à tout moment dans le futur. Si vous rencontrez un flux particulier qui ne peut pas être pris en charge par une combinaison des appels de l’API d’authentification Adobe Pass publics actuels, la meilleure approche consiste à nous le faire savoir. En tenant compte de vos besoins, nous pouvons modifier les API publiques et fournir une solution stable à l’avenir.
API ANDROID
- getInstance
- setOptions
- setRequestor
- setRequestorComplete
- checkAuthentication
- getAuthentication
- displayProviderDialog
- setSelectedProvider
- navigateToUrl
- getAuthenticationToken
- setAuthenticationStatus
- autoriser à l'avance
- checkAuthorization
- getAuthorization
- setToken
- tokenRequestFailed
- déconnexion
- getSelectedProvider
- selectedProvider
- getMetadata
- setMetadataStatus
- getVersion
Factory.getInstance
Description : instancie l'objet Access Enabler. Il doit y avoir une seule instance Access Enabler par instance d'application.
throws AccessEnablerException
public static AccessEnabler getInstance(ContextAppContext, String env_url, String softwareStatement, String redirectUrl)
throws AccessEnablerException
Disponibilité : v3.1.2+
Paramètres:
- appContext : contexte de l’application Android.
- env_url : pour les tests à l’aide de l’environnement d’évaluation Adobe, env_url peut être défini sur « sp.auth-staging.adobe.com »
Obsolète :
public static AccessEnabler getInstance(Context appContext)
throws AccessEnablerException
setRequestor
Description : établit l’identité du programmeur. Chaque programmeur se voit attribuer un ID unique lors de l’enregistrement avec l’Adobe pour le système d’authentification Adobe Pass. Lorsque vous traitez avec des jetons SSO et distants, l'état d'authentification peut changer lorsque l'application est en arrière-plan, setRequestor peut être appelé à nouveau lorsque l'application est mise en premier plan afin de se synchroniser avec l'état du système (récupérer un jeton distant si SSO est activé ou supprimer le jeton local si une déconnexion s'est produite en attendant).
La réponse du serveur contient une liste de fichiers MVPD ainsi que des informations de configuration associées à l’identité du programmeur. La réponse du serveur est utilisée en interne par le code d’activation d’Access. Seul le statut de l’opération (c’est-à-dire SUCCÈS/ÉCHEC) est présenté à votre application via le rappel setRequestorComplete().
Si le paramètre urls n’est pas utilisé, l’appel réseau résultant cible l’URL du fournisseur de services par défaut : l’environnement de publication/production d’Adobe.
Si une valeur est fournie pour le paramètre urls, l’appel réseau résultant cible toutes les URL fournies dans le paramètre urls. Toutes les demandes de configuration sont déclenchées simultanément dans des threads distincts. Le premier répondant est prioritaire lors de la compilation de la liste des MVPD. Pour chaque MVPD de la liste, Access Enabler mémorise l’URL du fournisseur d’accès associé. Toutes les demandes de droits suivantes sont dirigées vers l’URL associée au fournisseur de services qui a été associé au MVPD cible pendant la phase de configuration.
public void setRequestor(String requestorId)Disponibilité : v3.0+
public void setRequestor(String requestorId, ArrayList<String> urls)Disponibilité : v3.0+
Paramètres:
-
requestorID : ID unique associé au programmeur. Transmettez l’ID unique attribué par Adobe à votre site lors de votre premier enregistrement auprès du service d’authentification Adobe Pass.
-
signedRequestorID : copie de l’ID du demandeur signé numériquement avec votre clé privée. .
-
urls : paramètre facultatif ; par défaut, le fournisseur d’accès Adobe est utilisé (http://sp.auth.adobe.com/). Ce tableau vous permet de spécifier des points d’entrée pour les services d’authentification et d’autorisation fournis par Adobe (différentes instances peuvent être utilisées à des fins de débogage). Vous pouvez l’utiliser pour spécifier plusieurs instances de fournisseur de services d’authentification Adobe Pass. Ce faisant, la liste MVPD est composée des points d’entrée de tous les fournisseurs de services. Chaque MVPD est associé au fournisseur de services le plus rapide, c’est-à-dire le fournisseur qui a répondu en premier et qui prend en charge ce MVPD.
Rappels déclenchés : setRequestorComplete()
Obsolète :
public void setRequestor(String requestorId, String signedRequestorId)
public void setRequestor (String requestorId, String signedRequestorId, ArrayList<String> url)
setRequestorComplete
Description : rappel déclenché par Access Enabler qui informe votre application que la phase de configuration est terminée. Il s’agit d’un signal indiquant que l’application peut commencer à émettre des demandes de droits. Aucune demande de droits ne peut être émise par l’application tant que la phase de configuration n’est pas terminée.
Disponibilité : v1.0+
Paramètres:
-
status : peut prendre l'une des valeurs suivantes :
-
SDK >= 3.4.0
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS- la phase de configuration s’est terminée avec succèsAccessEnablerConstants.ACCESS_ENABLER_STATUS_ERROR- échec de la phase de configuration
-
SDK < 3.4
AccessEnabler.ACCESS_ENABLER_STATUS_SUCCESS- la phase de configuration s’est terminée avec succèsAccessEnabler.ACCESS_ENABLER_STATUS_ERROR- échec de la phase de configuration
-
Déclenché par : setRequestor()
setOptions
Description : configure les options globales de SDK. Elle accepte un Map<String, String> comme argument. Les valeurs du mappage seront transmises au serveur avec chaque appel réseau effectué par le SDK.
Les valeurs seront transmises au serveur indépendamment du flux actuel (authentification/autorisation). Si vous souhaitez modifier les valeurs, vous pouvez appeler cette méthode à tout moment.
Disponibilité : v1.9.2+
Paramètres:
-
options : Map<String, String> contenant des options SDK globales. Actuellement, les options suivantes sont disponibles :
- applicationProfile - Peut être utilisé pour effectuer des configurations de serveur en fonction de cette valeur.
- ap_vi - Identifiant Experience Cloud (visitorID). Cette valeur peut être utilisée ultérieurement pour les rapports d’analyse avancée.
- ap_ai - Advertising ID
- device_info - Informations du client comme décrit ici : Transmission des informations du client, connexion du périphérique et application.
checkAuthentication
Description : vérifie le statut d’authentification. Pour ce faire, il recherche un jeton d’authentification valide dans l’espace de stockage du jeton local. Cette méthode n’effectue aucun appel réseau et nous vous recommandons de l’appeler sur le thread principal. Il est utilisé par l’application pour interroger le statut d’authentification de l’utilisateur et mettre à jour l’interface utilisateur en conséquence (c’est-à-dire mettre à jour l’interface utilisateur de connexion/déconnexion). Le statut de l'authentification est communiqué à l'application via le rappel setAuthenticationStatus().
Si un MVPD prend en charge la fonction « Authentification par demandeur », plusieurs jetons d’authentification peuvent être stockés sur un appareil. Pour plus d’informations sur cette fonctionnalité, consultez la section Instructions de mise en cachede la présentation technique d’Android.
Disponibilité : v1.0+
Paramètres: Aucun
Rappels déclenchés : setAuthenticationStatus()
getAuthentication
Description : démarre le workflow d’authentification complet. Il commence par vérifier le statut de l’authentification. S’il n’est pas déjà authentifié, la machine d’état du flux d’authentification est démarrée :
- Si la dernière tentative d’authentification a réussi, la phase de sélection du MVPD est ignorée et le rappel navigateToUrl() est déclenché. L'application utilise ce rappel pour instancier le contrôle WebView qui présente à l'utilisateur la page de connexion MVPD.
- Si la dernière tentative d’authentification a échoué ou si l’utilisateur s’est explicitement déconnecté, le rappel displayProviderDialog() est déclenché. Votre application utilise ce rappel pour afficher l’interface utilisateur de sélection de MVPD. Votre application doit également reprendre le flux d’authentification en informant la bibliothèque Access Enabler de la sélection MVPD de l’utilisateur par le biais de la méthode setSelectedProvider().
Comme les informations d’identification de l’utilisateur sont vérifiées sur la page de connexion de MVPD, votre application doit surveiller les multiples opérations de redirection qui ont lieu lorsque l’utilisateur s’authentifie sur la page de connexion de MVPD. Lorsque les informations d'identification correctes sont saisies, le contrôle WebView est redirigé vers une URL personnalisée définie par la constante AccessEnabler.ADOBEPASS_REDIRECT_URL. Cette URL ne doit pas être chargée par le WebView. L’application doit intercepter cette URL et interpréter cet événement comme un signal indiquant que la phase de connexion est terminée. Il doit ensuite transmettre le contrôle à Access Enabler pour terminer le flux d’authentification (en appelant la méthode getAuthenticationToken()).
Si un MVPD prend en charge la fonction « Authentification par demandeur », plusieurs jetons d’authentification peuvent être stockés sur un appareil (un par programmeur). Pour plus d’informations sur cette fonctionnalité, consultez la section Instructions de mise en cachede la présentation technique d’Android.
Enfin, le statut de l'authentification est communiqué à l'application via le rappel setAuthenticationStatus().
Disponibilité : v1.0+
Disponibilité : v1.8+
Paramètres:
- forceAuthn : indicateur qui spécifie si le flux d’authentification doit être démarré, que l’utilisateur soit déjà authentifié ou non.
- data : carte composée de paires clé-valeur à envoyer au service de pass de télévision à péage. Adobe peut utiliser ces données pour activer les fonctionnalités futures sans modifier le SDK.
Rappels déclenchés : setAuthenticationStatus(), displayProviderDialog(), navigateToUrl(), sendTrackingData()
displayProviderDialog
Description rappel déclenché par Access Enabler pour informer l’application que les éléments appropriés de l’interface utilisateur doivent être instanciés pour permettre à l’utilisateur de sélectionner le MVPD souhaité. Le rappel fournit une liste d’objets MVPD avec des informations supplémentaires qui peuvent aider à créer correctement le panneau de l’interface utilisateur de sélection (comme l’URL pointant vers le logo MVPD, le nom d’affichage convivial, etc.)
Une fois que l’utilisateur a sélectionné le MVPD souhaité, l’application de couche supérieure doit reprendre le flux d’authentification en appelant setSelectedProvider() et en lui transmettant l’identifiant du MVPD correspondant à la sélection de l’utilisateur.
NOTENotez qu’il s’agit d’un point où l’utilisateur ou l’utilisatrice peut appuyer sur le bouton « Précédent », ce qui équivaut à l’abandon du flux d’authentification. Dans un tel scénario, votre application doit appeler la méthode
setSelectedProvider(), en transmettant null comme paramètre, pour donner à Access Enabler la possibilité de réinitialiser son ordinateur d’état d’authentification.public void displayProviderDialog(ArrayList<Mvpd> mvpds)Disponibilité : v1.0+
Paramètres :
- mvpds : liste des objets MVPD contenant des informations liées à MVPD que l’application peut utiliser pour créer les éléments de l’interface utilisateur de sélection de MVPD.
Déclenché par : getAuthentication(), getAuthorization()
setSelectedProvider
Description : cette méthode est appelée par votre application pour informer Access Enabler de la sélection MVPD de l’utilisateur. L’application peut utiliser cette méthode pour sélectionner ou modifier le fournisseur de services utilisé pour l’authentification.
Si le MVPD sélectionné est un MVPD TempPass, il s’authentifiera automatiquement avec ce MVPD sans avoir à appeler getAuthentication() par la suite.
Notez que cela n’est pas possible pour le transfert temporaire promotionnel où des paramètres supplémentaires sont donnés sur la méthode getAuthentication().
Lors de la transmission du paramètre null, Access Enabler suppose que l’utilisateur a annulé le flux d’authentification (c’est-à-dire qu’il a appuyé sur le bouton « Retour ») et répond en réinitialisant l’état-machine d’authentification et en appelant le rappel setAuthenticationStatus() avec le code d’erreur AccessEnablerConstants.PROVIDER_NOT_SELECTED_ERROR.
Disponibilité : v1.0+
Paramètres: Aucun
Rappels déclenchés : setAuthenticationStatus(), sendTrackingData(), navigateToUrl()
navigateToUrl
Obsolète : à partir d’Android SDK 3.0, navigateToUrl est utilisé uniquement si l’onglet personnalisé Chrome n’est pas présent sur l’appareil
Description : rappel déclenché par Access Enabler qui informe l’application que l’utilisateur doit recevoir la page de connexion de MVPD pour saisir ses informations d’identification. Access Enabler transmet en tant que paramètre l’URL de la page de connexion de MVPD. Votre application est nécessaire pour instancier un contrôle WebView et le diriger vers cette URL. En outre, l'application est nécessaire pour surveiller les URL chargées par le contrôle WebView et intercepter l'opération de redirection ciblant l'URL personnalisée définie par la constante AccessEnabler.ADOBEPASS_REDIRECT_URL (deprecated). Lors de cet événement, l'application doit fermer ou masquer le contrôle WebView et le rendre à la bibliothèque Access Enabler en appelant la méthode getAuthenticationToken(). Access Enabler termine le flux d’authentification en récupérant le jeton d’authentification du serveur principal et en le stockant localement dans le stockage des jetons.
WARNINGNotez qu’il s’agit d’un point où l’utilisateur peut appuyer sur le bouton « Précédent », ce qui équivaut à un abandon du flux d’authentification. Dans un tel scénario, votre application doit appeler la méthode setSelectedProvider() en transmettant null en tant que paramètre et en donnant une chance à Access Enabler de réinitialiser son état d'authentification.
Disponibilité : v1.0+
Paramètres:
- url : URL pointant vers la page de connexion de MVPD
Déclenché par : getAuthentication(), setSelectedProvider()
getAuthenticationToken
Obsolète : à partir d’Android SDK 3.0, étant donné que l’onglet personnalisé Chrome est utilisé pour l’authentification, cette méthode n’est plus utilisée à partir de l’application.
Description : termine le flux d’authentification en demandant le jeton d’authentification au serveur principal. Cette méthode ne doit être appelée par votre application qu’en réponse à un événement où le contrôle WebView hébergeant la page de connexion MVPD est redirigé vers l’URL personnalisée définie par la constante AccessEnabler.ADOBEPASS_REDIRECT_URL.
Disponibilité : v1.0+
Paramètres:
- cookies : cookies définis sur le domaine cible (voir l’application de démonstration dans le SDK pour une implémentation de référence).
Rappels déclenchés : setAuthenticationStatus(), sendTrackingData()
setAuthenticationStatus
Description : rappel déclenché par Access Enabler qui informe
application du statut du flux d’authentification. Il y en a beaucoup
les endroits où ce flux peut échouer, soit en raison de
interaction ou en raison d’autres scénarios imprévus (par ex. réseau)
problèmes de connectivité, etc.). Ce rappel informe l’application de
le statut de réussite/échec du flux d’authentification, ainsi que
fournir des informations supplémentaires sur le motif de l’échec, le cas échéant.
Disponibilité : v1.0+
Paramètres:
-
status : peut prendre l'une des valeurs suivantes :
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS- flux d’authentification terminé avec succèsAccessEnablerConstants.ACCESS_ENABLER_STATUS_ERROR- échec du flux d’authentification
-
code : motif de l’échec. Si status est
AccessEnablerConstants.ACCESS_ENABLER_STATUS_SUCCESS, alors code est une chaîne vide (c’est-à-dire définie par la constanteAccessEnablerConstants.USER_AUTHENTICATED). En cas d’échec, ce paramètre peut prendre l’une des valeurs suivantes :AccessEnablerConstants.USER_NOT_AUTHENTICATED_ERROR- L’utilisateur n’est pas authentifié. En réponse à l’appel de la méthode checkAuthentication() lorsqu’il n’existe aucun jeton d’authentification valide dans le cache de jetons local.AccessEnablerConstants.PROVIDER_NOT_SELECTED_ERROR- L’AccessEnabler a réinitialisé l’ordinateur d’état d’authentification après que l’application de couche supérieure a transmis null àsetSelectedProvider()pour abandonner le flux d’authentification. L’utilisateur a probablement annulé le flux d’authentification (c’est-à-dire qu’il a appuyé sur le bouton « Précédent »).AccessEnablerConstants.GENERIC_AUTHENTICATION_ERROR- Le flux d’authentification a échoué pour des raisons telles que l’indisponibilité du réseau ou l’annulation explicite du flux d’authentification.
Déclenché par : checkAuthentication(), getAuthentication(), checkAuthorization()
checkPreauthorizedResources
Obsolète : à partir d’Android SDK 3.6, l’API preauthorize remplace checkResources en fournissant des codes d’erreur étendus.
Description : cette méthode est utilisée par l’application pour déterminer si l’utilisateur est déjà autorisé à afficher des ressources protégées spécifiques. L’objectif principal de cette méthode est de récupérer des informations à utiliser pour décorer l’interface utilisateur (par exemple, en indiquant le statut d’accès avec des icônes de verrouillage et de déverrouillage).
public void checkPreauthorizedResources(ArrayList<String> resources)Disponibilité : v1.3+
Paramètres : le paramètre resources est un tableau de ressources pour lequel l’autorisation doit être vérifiée. Chaque élément de la liste doit être une chaîne représentant l’identifiant de la ressource. L’ID de ressource est soumis aux mêmes limitations que l’ID de ressource dans l’appel getAuthorization(). En d’autres termes, il doit s’agir d’une valeur convenue entre le programmeur et le MVPD ou d’un fragment RSS de média.
Rappel déclenché : preauthorizedResources()
checkPreauthorizedResources
Obsolète : à partir d’Android SDK 3.6, l’API preauthorize remplace checkResources en fournissant des codes d’erreur étendus.
Description : cette méthode est utilisée par l’application pour déterminer si l’utilisateur est déjà autorisé à afficher des ressources protégées spécifiques. L’objectif principal de cette méthode est de récupérer des informations à utiliser pour décorer l’interface utilisateur (par exemple, en indiquant le statut d’accès avec des icônes de verrouillage et de déverrouillage).
public void checkPreauthorizedResources(ArrayList<String> resources, boolean cache)Disponibilité : v3.1+
Paramètres : le paramètre resources est un tableau de ressources pour lequel l’autorisation doit être vérifiée. Chaque élément de la liste doit être une chaîne représentant l’identifiant de la ressource. L’ID de ressource est soumis aux mêmes limitations que l’ID de ressource dans l’appel getAuthorization(). En d’autres termes, il doit s’agir d’une valeur convenue entre le programmeur et le MVPD ou d’un fragment RSS de média.
Le paramètre cache indique si la réponse de préautorisation mise en cache peut être utilisée ou non. Par défaut, le cache est défini sur true et le SDK renvoie une réponse précédemment mise en cache si elle est disponible.
Rappel déclenché : preauthorizedResources()
preauthorizedResources
Obsolète : à partir d’Android SDK 3.6, l’API preauthorize remplace checkResources en fournissant des codes d’erreur étendus. Le rappel preauthorizedResources ne sera pas appelé sur la nouvelle API.
Description : rappel déclenché par checkPreauthorizedResources(). Fournit une liste des ressources que l’utilisateur est déjà autorisé à afficher.
public void checkPreauthorizedResources(ArrayList<String> resources)Disponibilité : v1.3+
Paramètres : le paramètre resources est un tableau de ressources que l’utilisateur est déjà autorisé à afficher.
Déclenché par : checkPreauthorizedResources()
checkAuthorization
Description : cette méthode est utilisée par l’application pour vérifier le statut de l’autorisation. Il commence par vérifier d’abord le statut de l’authentification. S’il n’est pas authentifié, le rappel setTokenRequestFailed() est déclenché et la méthode se ferme. Si l’utilisateur est authentifié, cela déclenche également le flux d’autorisation. Voir les détails sur la méthode getAuthorization().
Disponibilité : v1.0+
Disponibilité : v1.8+
Paramètres:
- resourceId : ID de la ressource pour laquelle l’utilisateur demande une autorisation.
- data : carte composée de paires clé-valeur à envoyer au service de pass de télévision à péage. Adobe peut utiliser ces données pour activer les fonctionnalités futures sans modifier le SDK.
Rappels déclenchés : tokenRequestFailed(), setToken(),sendTrackingData(), setAuthenticationStatus()
getAuthorization
Description : cette méthode est utilisée par l’application pour lancer le flux d’autorisation. Si l’utilisateur n’est pas déjà authentifié, il lance également le flux d’authentification. Si l’utilisateur est authentifié, Access Enabler émet des demandes pour le jeton d’autorisation (si aucun jeton d’autorisation valide n’est présent dans le cache de jetons local) et pour le jeton de média de courte durée. Une fois le jeton de média court obtenu, le flux d’autorisation est considéré comme terminé. Le rappel setToken() est déclenché et le jeton de média court est fourni en tant que paramètre à l’application. Si, pour une raison quelconque, l’autorisation échoue, le rappel tokenRequestFailed() est déclenché et le code d’erreur et les détails sont fournis.
Disponibilité : v1.0+
Disponibilité : v1.8+
Paramètres:
- resourceId : ID de la ressource pour laquelle l’utilisateur demande une autorisation.
- data : carte composée de paires clé-valeur à envoyer au service de pass de télévision à péage. Adobe peut utiliser ces données pour activer les fonctionnalités futures sans modifier le SDK.
Rappels déclenchés : tokenRequestFailed(), setToken(), sendTrackingData()
WARNINGCette méthode peut également déclencher les rappels suivants (si le flux d’authentification est également initié) : setAuthenticationStatus(), displayProviderDialog(), navigateToUrl()
REMARQUE : utilisez checkAuthorization() au lieu de getAuthorization() dans la mesure du possible. La méthode getAuthorization() lance un flux d'authentification complet (si l'utilisateur n'est pas authentifié), ce qui peut entraîner une implémentation compliquée du côté du programmeur.
setToken
Description : rappel déclenché par Access Enabler qui informe votre application que le flux d’autorisation a été terminé avec succès. Le jeton de média de courte durée est également diffusé en tant que paramètre.
Disponibilité : v1.0+
Paramètres:
- token : jeton de média de courte durée.
- resourceId : ressource pour laquelle l’autorisation a été obtenue
Déclenché par : checkAuthorization(), getAuthorization()
tokenRequestFailed
Description : rappel déclenché par Access Enabler qui informe l’application de couche supérieure de l’échec du flux d’autorisation.
String errorCode, String errorDescription)
Disponibilité : v1.0+
Paramètres:
-
resourceId : ressource pour laquelle l’autorisation a été obtenue
-
errorCode : code d’erreur associé au scénario d’échec. Valeurs possibles :
AccessEnablerConstants.USER_NOT_AUTHORIZED_ERROR- L’utilisateur n’a pas pu autoriser pour la ressource donnée.
-
errorDescription : informations supplémentaires sur le scénario d’échec. Si cette chaîne descriptive n’est disponible pour aucune raison, l’authentification Adobe Pass envoie une chaîne vide (« »).
Cette chaîne peut être utilisée par un MVPD pour transmettre des messages d’erreur personnalisés ou des messages liés aux ventes. Par exemple, si l’autorisation d’accès à une ressource est refusée à un abonné, le MVPD peut envoyer un message du type : « Vous n’avez pas accès à ce canal dans votre package. Si vous souhaitez mettre à niveau votre package, cliquez ici. » Le message est transmis par l’authentification Adobe Pass via ce rappel au programmeur, qui a la possibilité de l’afficher ou de l’ignorer. L’authentification Adobe Pass peut également utiliser ce paramètre pour fournir une notification de la condition qui a pu entraîner une erreur. Par exemple, « Une erreur réseau s’est produite lors de la communication avec le service d’autorisation du fournisseur ».
Déclenché par : checkAuthorization(), getAuthorization()
déconnexion
Description : utilisez cette méthode pour lancer le flux de déconnexion. La déconnexion est le résultat d’une série d’opérations de redirection HTTP en raison du fait que l’utilisateur doit être déconnecté des serveurs d’authentification Adobe Pass et des serveurs de MVPD. Par conséquent, ce flux ne peut pas être exécuté avec une simple requête HTTP émise par la bibliothèque Access Enabler. Un onglet personnalisé Chrome est utilisé par le SDK pour exécuter les opérations de redirection HTTP. Ce flux sera visible pour l’utilisateur et fermé une fois terminé
Disponibilité : v1.0+
Paramètres: Aucun
Rappels déclenchés :
navigateToUrl()pour les versions de SDK antérieures à la version 3.0setAuthenticationStatus()pour SDK version > 3.0
getSelectedProvider
Description : utilisez cette méthode pour déterminer le fournisseur actuellement sélectionné.
Disponibilité : v1.0+
Paramètres: Aucun
Rappels déclenchés : selectedProvider()
selectedProvider
Description : rappel déclenché par Access Enabler qui fournit des informations sur le MVPD actuellement sélectionné à l’application.
Disponibilité : v1.0+
Paramètres:
- mvpd : objet contenant des informations sur le MVPD actuellement sélectionné
Déclenché par : getSelectedProvider()
getMetadata
Description : utilisez cette méthode pour récupérer des informations exposées en tant que métadonnées par la bibliothèque Access Enabler. L’application peut accéder à ces informations en fournissant un objet MetadataKey composite.
public void getMetadata(MetadataKey metadataKey)Disponibilité : v1.0+
Les programmeurs ont accès à deux types de métadonnées :
- Métadonnées statiques (TTL de jeton d’authentification, TTL de jeton d’autorisation et ID d’appareil)
- Métadonnées utilisateur (informations spécifiques à l’utilisateur, telles que l’identifiant utilisateur et le code postal ; transmises d’un MVPD à l’appareil d’un utilisateur lors des flux d’authentification et/ou d’autorisation)
Paramètres:
-
metadataKey : structure de données qui encapsule une clé et une variable args, avec la signification suivante :
-
Si la clé est
METADATA_KEY_USER_METAet que les arguments contiennent un objet SerializableNameValuePair avec le nom =METADATA_ARG_USER_METAet la valeur =[metadata_name], la requête porte sur les métadonnées de l’utilisateur. Liste actuelle des types de métadonnées utilisateur disponibles :-
zip- Code postal -
householdID- Identifiant du ménage. Si un MVPD ne prend pas en charge les sous-comptes, celui-ci est identique àuserID. -
maxRating- Évaluation parentale maximale pour l'utilisateur -
userID- Identifiant de l’utilisateur. Si un MVPD prend en charge les sous-comptes et que l’utilisateur n’est pas le compte principal,userIDsera différent dehouseholdID. -
channelID- Liste des canaux que l’utilisateur est autorisé à afficher
-
-
Si la clé est
METADATA_KEY_DEVICE_ID, la requête est effectuée pour obtenir l’identifiant d’appareil actuel. Notez que cette fonctionnalité est désactivée par défaut et les programmeurs doivent contacter l’Adobe pour plus d’informations sur l’activation et les frais. -
Si la clé est
METADATA_KEY_TTL_AUTHZet que les arguments contiennent un objet SerializableNameValuePair avec le nom =METADATA_ARG_RESOURCE_IDet la valeur =[resource_id], la requête est exécutée pour obtenir le délai d’expiration du jeton d’autorisation associé à la ressource spécifiée. -
Si la clé est
METADATA_KEY_TTL_AUTHN, la requête est effectuée pour obtenir le délai d’expiration du jeton d’authentification.
-
NOTEMETADATA_KEY_USER_META, METADATA_KEY_DEVICE_ID, METADATA_KEY_TTL_AUTHZ, METADATA_KEY_TTL_AUTHN sont disponibles à partir de com.adobe.adobepass.accessenabler.api.profile.UserProfileService.NOTERappels déclenchés : setMetadataStatus()
Informations supplémentaires : Métadonnées utilisateur
setMetadataStatus
Description : rappel déclenché par Access Enabler qui fournit les métadonnées demandées via un appel getMetadata().
public void setMetadataStatus(MetadataKey key, MetadataStatus result)Disponibilité : v1.0+
Paramètres:
-
key : objet MetadataKey contenant la clé pour laquelle la valeur de métadonnées est demandée et les paramètres associés (voir l’application de démonstration pour une implémentation de référence).
-
result : objet composite contenant les métadonnées demandées. L’objet comporte les champs suivants :
-
simpleResult : une chaîne qui représente la valeur des métadonnées au moment où la demande a été faite pour la TTL d’authentification, la TTL d’autorisation ou l’ID d’appareil. Cette valeur est nulle si la demande porte sur les métadonnées de l’utilisateur.
-
userMetadataResult : objet contenant la représentation Java d’une payload de métadonnées d’utilisateur JSON.
Par exemple :
-
'{
"street": "Main Avenue",
"buildings": ["150", "320"]
}'
est traduit en Java comme suit :
Map("street" -> "Main Avenue", "buildings" -> List("150", "320")))
La structure réelle des objets de métadonnées utilisateur est similaire à ce qui suit :
{
updated: 1334243471,
encrypted: ["encryptedProp"],
data: {
zip: ["12345", "34567"],
maxRating: {
"MPAA": "PG-13",
"VCHIP": "TV-Y",
"URL": "http://exam.pl/e/manage/ratings"
},
householdID: "3456",
userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
channelID: ["channel-1", "channel-2"]
}
}
Cette valeur est nulle lorsque la demande porte sur des métadonnées simples (TTL d’authentification, TTL d’autorisation ou ID d’appareil).
- encrypted : valeur booléenne qui spécifie si les métadonnées récupérées sont chiffrées ou non. Ce paramètre est important uniquement pour les requêtes de métadonnées d’utilisateur. Il n’a aucune signification pour les métadonnées statiques (par exemple : TTL d’authentification) qui sont toujours reçues non chiffrées. Si ce paramètre est défini sur True, il revient au programmeur d'obtenir la valeur non chiffrée des métadonnées de l'utilisateur en effectuant un déchiffrement RSA à l'aide de la clé privée placée sur la liste blanche (la même clé privée que celle utilisée pour la signature de l'ID du demandeur dans l'appel
setRequestor).
Déclenché par : getMetadata()
Informations supplémentaires : Métadonnées utilisateur
getVersion
Description : cette méthode peut être utilisée pour récupérer la version de la bibliothèque AccessEnabler.
public static String getVersion()Suivi des événements
Access Enabler déclenche un rappel supplémentaire qui n’est pas nécessairement lié aux flux de droits. L’implémentation de la fonction de rappel de suivi des événements nommée sendTrackingData() est facultative, mais elle permet à l’application de suivre des événements spécifiques et de compiler des statistiques, telles que le nombre de tentatives d’authentification/d’autorisation réussies/ayant échoué. Vous trouverez ci-dessous la spécification du rappel sendTrackingData() :
sendTrackingData
Description : rappel déclenché par le Gestionnaire d’accès signalant à l’application l’occurrence de divers événements tels que l’achèvement/l’échec des flux d’authentification/d’autorisation. Le type d’appareil, le type de client Access Enabler et le système d’exploitation sont également signalés par sendTrackingData().
WARNING-
Valeurs possibles pour le type d’appareil :
computertabletmobilegameconsoleunknown
-
Valeurs possibles pour le type de client Access Enabler :
flashhtml5iosandroid
public void sendTrackingData(Event event, ArrayList<String> data)Disponibilité : v1.0+
Paramètres:
-
event : l’événement qui fait l’objet d’un suivi. Il existe trois types d'événements de tracking possibles :
- authorizationDetection : chaque fois qu’une demande de jeton d’autorisation est renvoyée (type d’événement
EVENT_AUTHZ_DETECTION) - authenticationDetection : à chaque vérification de l’authentification (le type d’événement est
EVENT_AUTHN_DETECTION) - mvpdSelection : lorsque l’utilisateur sélectionne un MVPD dans le formulaire de sélection MVPD (le type d’événement est
EVENT_MVPD_SELECTION)
- authorizationDetection : chaque fois qu’une demande de jeton d’autorisation est renvoyée (type d’événement
-
data : données supplémentaires associées à l’événement signalé. Ces données sont présentées sous la forme d’une liste de valeurs.
Vous trouverez ci-dessous des instructions pour interpréter les valeurs dans le data
tableau :
-
Pour le type d’événement
EVENT_AUTHN_DETECTION:- 0 - Indique si la demande de jeton a réussi (true/false) et si ce qui précède est vrai :
- 1 - Chaîne d’identifiant MVPD
- 2 - GUID (md5 haché)
- 3 - Jeton déjà présent dans le cache (true/false)
- 4 - Type d’appareil
- 5 - Type de client Access Enabler
- 6 - Type de système d’exploitation
-
Pour le type d’événement
EVENT_AUTHZ_DETECTION- 0 - Indique si la demande de jeton a réussi (true/false) et, si elle a réussi :
- 1 - MVPD ID
- 2 - GUID (md5 haché)
- 3 - Jeton déjà présent dans le cache (true/false)
- 4 - Erreur
- 5 - Détails
- 6 - Type d’appareil
- 7 - Type de client Access Enabler
- 8 - Type de système d’exploitation
-
Pour le type d’événement
EVENT_MVPD_SELECTION- 0 - ID du MVPD actuellement sélectionné
- 1 - Type d’appareil
- 2 - Type de client Access Enabler
- 3 - Type de système d’exploitation
Déclenché par : checkAuthentication(), getAuthentication(), checkAuthorization(), getAuthorization(), setSelectedProvider()