Configuration requise

Connaissances préalables

  • Compréhension d'AEM Mobile
  • Maîtrise du processus de création et de publication de contenu via le portail à la demande
  • Expérience avec les interfaces On-Demand Services API

Produits requis

  • AEM Mobile
  • Accès à l'interface On-Demand Services API

Introduction

Adobe Experience Manager Mobile (AEM Mobile) propose une interface On-Demand Services API très puissante qui vous permet de créer un programme pour la gestion des articles, des collections, des produits, des notifications Push, etc. Cette API permet également des intégrations tierces avec les systèmes de gestion de contenu, les outils de création basés sur le web et les systèmes de flux de publication, dorénavant disponibles. (Pour plus d'informations, reportez-vous à la page Intégration de systèmes tiers avec AEM Mobile.)

Si vous voulez écrire un code personnalisé pour l'interface avec On-Demand Services API, ou si vous voulez utiliser l'une des intégrations existantes avec des systèmes tiers, vous devez disposer d'identifiants d'API valides. Cet article explique l'utilisation des clés d'API.

 

Identifiants d'API

Les identifiants d'API sont composés des éléments suivants :

  • La clé d'API et la clé secrète client sont les informations d'identification permettant d'accéder à la passerelle de l'API.
  • L'ID de périphérique et le jeton de périphérique sont les informations d'identification permettant d'identifier l'utilisateur de l'API.

Scénarios d'utilisation d'API et conditions

Selon la manière dont vous prévoyez d'utiliser une interface via les On-Demand Services API, les conditions suivantes s'appliquent.

Solution hébergée (mutualisée)

Exemples : WoodWing Enterprise, WoodWing Inception, Storied et Specle.

  • Chaque solution hébergée doit disposer de sa propre clé d'API.
  • Les utilisateurs de la solution hébergée n'ont pas besoin de leur propre clé d'API.
  • Le propriétaire de la solution fournit aux utilisateurs/aux clients cette clé d'API.
  • Les utilisateurs de la solution hébergée génèrent leurs propres ID de périphérique et jeton de périphérique en utilisant cette clé d'API, puis ils saisissent ces identifiants dans la solution hébergée.

Solution sur site (client unique)

Exemples : Adobe Experience Manager, vjoon K4, WordPress et Drupal.

  • Chaque client souhaitant déployer une solution sur site a besoin de sa propre clé d'API.
  • Un client peut utiliser sa clé d'API sur les différentes solutions sur site qu'il implémente.
  • Un client doit générer ses propres ID de périphérique et jeton de périphérique et saisir ces identifiants dans sa solution sur site.

Intégration personnalisée

Exemple : flux de travaux personnalisé codé par un partenaire ou un client.

  • Même conditions que pour une solution sur site (client unique).
  • Le client doit disposer de sa clé d'API, son ID de périphérique et son ou ses jetons de périphérique.

Reportez-vous aux sections suivantes pour plus d'informations sur l'acquisition des identifiants d'API dont vous avez besoin.

Demande d'une clé d'API

Une clé d'API permet d'accéder à la passerelle API d'Adobe. Cette passerelle est une infrastructure commune également utilisée par les API. Toutes les API publiques se trouvent derrière la passerelle API d'Adobe. Pour pouvoir interagir avec les services se trouvant derrière la passerelle API, vous devez disposer d'une clé d'API. Les clés d'API ne sont pas liées à un Adobe ID donné et n'expirent pas, sauf si Adobe les révoque. La clé d'API est composée de deux parties : le nom et la clé secrète. Vous pouvez considérer la clé secrète comme le « mot de passe » de la clé d'API.

La clé d'API et la clé secrète client portent parfois d'autres noms. Les termes suivants sont équivalents :

Clé d'API = « ID de client IMS » = « ID de client » = « Clé d'API Adobe » = « Clé Adobe »

Clé secrète client = « Clé secrète » = « Clé secrète d'API Adobe » = « Clé secrète Adobe »

Pour demander une clé d'API, téléchargez et envoyez le formulaire PDF de demande. Pour plus d'informations, reportez-vous à la page Intégration de systèmes tiers avec AEM Mobile : Clés d'API.

Nous vous recommandons de ne PAS utiliser les Adobe ID dotés du rôle Administrateur principal pour l'accès aux API. Utilisez les comptes dotés du rôle Administrateur principal uniquement pour la création de projet et l'ajout de comptes dédiés à chacun des projets. Par exemple, si vous avez une instance Drupal et une instance WordPress, et si votre administrateur principal est aemm_master@adobe.com, votre Adobe ID d'API dédié pour Drupal peut être aemm_drupal@adobe.com (qui n'est pas un administrateur principal). Votre Adobe ID dédié pour WordPress peut alors être aemm_wordpress@adobe.com (qui n'est pas un administrateur principal). Vous pouvez alors, par exemple, créer des projets appelés « Drupal Mag » et « WordPress Mag » avec aemm_master@adobe.com et ajouter aemm_drupal@adobe.com et aemm_wordpress@adobe.com à ces projets avec uniquement les rôles et autorisations nécessaires. (Accordez uniquement à ces comptes API dédiés les autorisations requises pour l'utilisation de l'API que vous avez prévue, telles que « Ajouter et modifier du contenu », « Supprimer du contenu », « Voir le contenu » et « Publier du contenu ». Pour connaître les autorisations spécifiques requises, consultez la documentation accompagnant votre solution. Reportez-vous à la page Administration de comptes pour AEM Mobile.

Si votre requête est accordée, vous obtiendrez un ID de client IMS (qui correspond à votre clé d'API) et votre clé secrète client. Votre Adobe ID spécifique sera « placé sur liste blanche » de sorte que vous puissiez créer des ID de périphérique et des jetons de périphérique associés, comme expliqués dans les étapes suivantes.

 

 

 

Génération de l'ID de périphérique et du jeton de périphérique

Lorsque vous disposez d'une clé d'API et d'une clé secrète client, vous devez générer un ID de périphérique et un jeton de périphérique, qui sont utilisés pour identifier l'utilisateur de l'API.

  1. Accédez au générateur de jeton pour périphérique IMS (« portail AEX ») à l'adresse https://aex.aemmobile.adobe.com/ et saisissez votre clé d'API/ID client IMS.
  2. Connectez-vous avec l'Adobe ID figurant sur liste blanche pour lequel vous voulez créer un ID/jeton de périphérique (l'un des Adobe ID que vous avez indiqués dans le formulaire de demande de clé d'API).
  3. Un ID de périphérique et un jeton de périphérique sont générés et affichés. Copiez et enregistrez-les dans un endroit sûr.

Notez que, si le mot de passe de l'Adobe ID est modifié, l'ID de périphérique et le jeton de périphérique deviennent non valides. Vous pouvez considérer l'ID de périphérique/le jeton de périphérique comme un hachage de l'Adobe ID et du mot de passe.

Notez également que l'ID de périphérique et le jeton de périphérique ne sont valides que pendant 6 mois et deviennent non valides s'ils ne sont pas utilisés. S'ils sont utilisés, ils sont automatiquement renouvelés.

Accès à l'API d'AEM Mobile

Si vous connectez un système tiers pris en charge via des API, vous devez simplement saisir la clé d'API et la clé secrète client (uniquement pour les solutions sur site/client unique), l'ID de périphérique et le jeton de périphérique dans les champs appropriés de la procédure de configuration du système.

Si vous accédez à l'API directement via votre propre code personnalisé, suivez la documentation figurant dans le pack de l'interface On-Demand Services API :

  • L'ID de périphérique et le jeton de périphérique sont utilisés pour générer un jeton d'accès via le point de terminaison de l'API d'authentification.
  • La combinaison de la clé d'API et du jeton d'accès est requise pour tous les appels d'API.

Utilisation des clés d'API dans les environnements de développement et de production

Si vous développez une intégration personnalisée, ou si vous avez des systèmes de production et de développement distincts sur site, il est conseillé d'utiliser des clés d'API distinctes pour le développement et la production.

Lorsque vous développez un nouveau système, vous pouvez demander une clé d'API en suivant la procédure décrite ci-dessus. Lorsque vous lancez le déploiement d'un système en production, vous devez demander une clé d'API supplémentaire.

Suppression progressive des comptes techniques d'ID de périphérique et de jeton de périphérique

Dans le futur, le flux de travaux d'ID de périphérique et de jeton de périphérique sera remplacé par l'implémentation d'un compte technique géré sur le portail à la demande. Les clés d'API seront toujours utilisées. Au lieu d'utiliser un ID de périphérique et un jeton périphérique pour l'authentification (et obtenir un jeton d'accès), le système fournira un « compte technique » qui pourra être utilisé pour demander un jeton d'accès. Pour lancer le traitement, un « jeton ponctuel » sera généré. Cet identifiant ne pourra être utilisé qu'une seule fois. Le propriétaire des informations du compte échangera le jeton ponctuel contre un jeton d'authentification via un service Adobe. Le jeton en résultant pourra être stocké pour une authentification future.

Ce produit est distribué sous licence Creative Commons Attribution - Pas d’utilisation commerciale - Partage à l’identique 3.0 non transposé  Les publications Twitter™ et Facebook ne sont pas couvertes par les dispositions Creative Commons.

Mentions légales   |   Politique de confidentialité en ligne