Configuration requise

Connaissances préalables

  • Compréhension d'AEM Mobile
  • Maîtrise du processus standard de création et de publication de contenu via le portail à la demande standard

Produits requis

  • AEM Mobile

Introduction

L'interface On-Demand Services API d'Adobe Experience Manager permet aux développeurs tiers d’intégrer leurs applications aux services à la demande. Ces services permettent les options suivantes :

  • Gestion des articles
  • Gestion des collections
  • Gestion des produits
  • Gestion des notifications Push

Les API de l'interface On-Demand Services API (précédemment appelées « API Content Producer Service ») sont les mêmes que les API utilisées par le portail à la demande (https://aemmobile.adobe.com).

API Content Producer Services d'Adobe Digital Publishing Solution

Intégration de la création AEM

Vous pouvez utiliser AEM pour produire des contenus pour les applications AEM Mobile. Contactez votre représentant Adobe si vous avez besoin d’informations complémentaires.

Intégrations d’applications tierces

Les solutions de flux de travaux éditoriaux, les solutions de création web et les systèmes Content Management Systems (CMS) suivants peuvent bénéficier d’options d’intégration (proposées par des partenaires d’Adobe) :

Systèmes CMS

Création web
Systèmes de processus

Présentation vidéo de l'intégration

Lors de la conférence MAX 2015, Klaasjan Tukker et Mike Yang ont présenté différentes possibilités avancées en termes de processus :

Advanced Workflow Possibilities with the Adobe APIs (Possibilités avancées en termes de flux de travaux avec les API Adobe) (1:25:57)

Téléchargements

Pour commencer à utiliser l’interface On-Demand Services API, téléchargez les fichiers indiqués ci-dessous.

Remarque :

En téléchargeant les logiciels mentionnés ci-après, vous reconnaissez avoir lu et accepter les conditions énoncées dans le document Licence des API pour AEM Mobile Services, les Conditions d’utilisation d’Adobe.com et la Politique de confidentialité en ligne d’Adobe.

Telechargement

Le fichier .zip contient les éléments suivants :

  • Documentation de l’API
  • Définitions du schéma JSON
  • Exemples de code
  • Exemples de scripts InDesign
  • Formulaire de demande de clé d'API

 

Utilisation de la documentation de l’API

Pour consulter la documentation de l’API (créée avec Swagger), décompressez les fichiers dans un dossier de votre serveur web (par exemple MAMP).

Si l’URL hébergée pour la documentation Swagger est http://localhost:8888/aemmobile-swagger, vous pouvez ignorer l’étape suivante.

Ouvrez le fichier service.json et modifiez la ligne n°55 de manière à définir basePath comme étant l’hôte + le chemin d’accès à votre documentation. Par exemple :

#53     "contact": "wwds@adobe.com"
#54   },
#55   "basePath": "http://localhost:8888/your-custom-path"
#56 }

Ouvrez votre navigateur web et accédez à l’emplacement où vous avez déployé la documentation. L'interface On-Demand Services API doit être visible.

 

Configuration de projets, de rôles et d’utilisateurs

Configurez un projet, créez des rôles et accordez l’accès aux utilisateurs. Pour plus d’informations, consultez les articles suivants de l’aide :

Il est recommandé d’éviter d’utiliser l’Adobe ID auquel ont été attribués les droits d’administration « Compte principal » ou « Projet complet ». Créez un Adobe ID spécifique pour accéder aux opérations que vous souhaitez autoriser via l’interface On-Demand Services API.

Remarque :

Pour exécuter les exemples suivants, veillez à créer un nouveau projet.

Clés d'API

Pour accéder à l'interface On-Demand Services API et pour l'intégrer aux systèmes tiers, vous avez besoin d'une clé d'API.

Demande d'une clé d'API

Pour accéder à l’interface On-Demand Services API, vous devez demander une clé d'API. Pour demander la clé d'API, complétez le formulaire PDF. Envoyez le formulaire renseigné au Support aux développeurs Adobe : wwds@adobe.com

Telechargement

Pour plus d'informations sur quand utiliser une clé d'API ou quand utiliser une clé existante, reportez-vous à la page Utilisation des clés d'API AEM Mobile.

Génération du device_id et du device_token

Une fois que vous avez reçu votre clé d'API, vous pouvez générer le device_id et le device_token. Rendez-vous sur le site https://aex.aemmobile.adobe.com et procédez comme suit :

  • Indiquez la clé d'API.
  • Connectez-vous avec un Adobe ID dont vous aurez au préalable demandé l’ajout sur la liste blanche (via le formulaire de demande).

Si toutes les conditions sont remplies, un device_id et un device_token sont générés.

Utilisation des fichiers d’exemple

Décompressez les exemples et modifiez les valeurs standard en fonction de votre compte et de vos clés d'API. Assurez-vous d’avoir créé un nouveau projet dans le portail à la demande et d’avoir attribué un rôle à l’Adobe ID qui sera utilisé pour la communication dans ces exemples d’API.

Modifiez :

  • config/credentials.php

Modifiez/ajoutez les valeurs suivantes : « client_id » (votre clé d'API), « client_secret », « device_token », « device_id » (fournis par le service AEX).

Définissez la valeur de « client_version » ; celle-ci permet d’identifier votre « system » lors de la communication avec l’interface On-Demand Services API. Par exemple, « aemmobile-learn-api-doc-1.0 »

Exécutez :

  • demo/01_get_access_token.php

Si le fichier a été configuré correctement, la réponse doit vous fournir un « access_token » (jeton d'accès). Utilisez cette valeur access_token dans les appels de service suivants.

Modifiez :

  • config/credentials.php

Ajoutez la valeur correspondant à « access_token ».

Exécutez :

  • demo/02_get_user_permissions.php

Si le fichier a été configuré correctement, la réponse doit vous fournir la liste des projets auxquels cet Adobe ID (pour lequel le device_id/device_token a été généré) a accès.

Sélectionnez le projet avec lequel vous souhaitez interagir. (Il doit s’agir d’un nouveau projet créé récemment.) Le projet est identifié par un GUID, de type « 8dbeb5da-ca73-d0da-b0b0-885fb83e7ae8 ».

Modifiez :

  • Config/parameters.php

Mettez à jour « publication_id » avec votre ID de projet, obtenu ci-dessus.

Exécutez :

  • demo/03_update_home_collection.php

Si la configuration est correctement effectuée, la collection globale aura un état publiable, avec vignette de chargement et image d’arrière-plan, en définissant l’ID du produit et associant l’affichage par défaut.

Modifiez :

  • config/parameters.php

Si le projet cible est une collection globale 2, veuillez mettre à jour la valeur « collection_home_name » de « topLevelContent » en « topLevelTabletContent » pour les tablettes (ou « topLevelPhoneContent » pour les smartphones).

Vous pouvez maintenant exécuter le reste des exemples. Lorsque vous exécutez des exemples, gardez ouverte une fenêtre de navigateur affichant la section « Contenu et mises en page » de vos projets dans le portail à la demande. Vous pourrez ainsi suivre en direct l’application des modifications dans votre navigateur, pendant que vous exécutez les exemples.

 

Création d’articles

Le contenu des articles peut être créé en HTML ou via InDesign.

Articles HTML

Les articles créés en HTML peuvent utiliser du code CSS/JS afin d’appliquer un style visuel au contenu et de le rendre dynamique. L’ensemble du contenu HTML doit être placé dans un même dossier (sous-dossiers autorisés). Les fichiers HTML sont ensuite compressés dans un fichier zip contenant un fichier manifest.xml. Ce fichier manifeste répertorie les articles inclus dans le fichier zip et contient l’empreinte MD5. (Reportez-vous à la page Création d'articles HTML pour AEM Mobile.)

Pour générer les fichiers d’article à partir d’un dossier, vous pouvez utiliser soit l’utilitaire de bureau, soit l’utilitaire fourni dans l’exemple, dans « class/manifest.php ».

Articles InDesign

Avec Adobe InDesign CS6 ou version ultérieure, vous pouvez créer des fichiers d’article à mise en page fixe. Le plug-in Digital Publishing vous permet d’exporter du contenu InDesign dans un fichier d’article. (Reportez-vous à la page Création d'articles AEM Mobile dans InDesign.)

Pour assurer le processus d’exportation via un script, vous pouvez utiliser la fonction « exportDpsArticle ». Pour plus d'informations, reportez-vous à la page Création d’articles basés sur InDesign à l’aide de scripts.

Questions et assistance technique

Vous pouvez poser toutes vos questions relatives à cet article ou à l’utilisation de l'interface On-Demand Services API sur le forum API / Intégration. Si vous recherchez une assistance individualisée, contactez le Support aux développeurs Adobe (wwds@adobe.com).

Journal des modifications

20 juin 2017

Documentation mise à jour :

  • Correction d’une faute d’orthographe dans la description.

7 février 2017

Documentation mise à jour :

  • Prise en charge ajoutée pour le contenu partagé dynamique dans Producer Services.

Schéma JSON mis à jour :

  • Nouveau schéma JSON ajouté pour le contenu partagé dynamique

Exemples d'API

  • Prise en charge ajoutée pour le contenu partagé dynamique

1er novembre 2016

Documentation mise à jour :

  • Retour batch du statut de l'entité ajouté.
  • Prise en charge ajoutée pour les bannières dynamiques dans Producer Service et Ingestion Service.
  • Ajout de la prise en charge de la notification Push Android via l'API du service de notification.
  • Ajout de la possibilité de mise à jour de la liste des éléments de contenu de la collection suivant un index spécifié.

Schéma JSON mis à jour :

  • Nouveau schéma JSON ajouté pour la bannière dynamique

Exemples d'API mises à jour :

  • Mises à jour de Collection::updateContentElements() afin de vérifier son existence avant d'ajouter l'entité à la liste des éléments de contenu de la collection
  • Ajout de la prise en charge pour les bannières dynamiques
  • Bannière dynamique ajoutée aux scripts de démonstration (13-15)

12 juillet 2016

Documentation mise à jour :

  • Produit et regroupement de produits mis à jour

30 juin 2016

Documentation mise à jour :

  • Ajout d'informations sur le chargement de PDF pour Ingestion Service

Schéma JSON mis à jour : 12 juillet 2016

Documentation mise à jour :

  • Champs de métadonnées supplémentaires ajoutés :
    • contentSize
    • availabilityDate (produit et regroupement de produits uniquement)
    • availabilityDateTimezone (produit et regroupement de produits uniquement)

Exemples d'API mises à jour :

  • Démonstration : #05e mise à jour du fichier PDF dans l'article un
  • Démonstration : #05f mise à jour du fichier PDF dans l'article un et définition du balayage horizontal
  • Démonstration : #05g contrôle du statut d'importation pour l'article un
  • Bascule pour utiliser l'outil d'auto-chargement (« autoloader ») afin de charger les classes requises par script PHP

10 mai 2016

Documentation mise à jour :

  • Ingestion Service accepte désormais l'en-tête : application/pdf
  • Suivi du statut des travaux de publication/annulation de la publication et contrôle en amont
    • POST /travail retourne l'ID de flux de travaux pour ce travail
    • GET /statut/{publicationID}/publication/00000000-0000-0000-0000-000000000000 retourne l'ID de flux de travaux actuel (si disponible)
    • Comparatif entre l’ID de flux de travaux actuel (si disponible) et le dernier ID de flux de travaux connu
      • si l'ID de flux de travaux actuel === le dernier ID de flux de travaux connu, le dernier travail est toujours en cours
      • si l'ID de flux de travaux actuel !== le dernier ID de flux de travaux connu, le dernier travail est terminé et un autre est en cours
      • si l'ID de flux de travaux actuel est vide, le dernier travail est terminé et aucun autre travail n'est en cours

Exemples d'API mises à jour :

  • Démonstration : #05d contrôle de la taille du fichier de contenu chargé actuel
  • Démonstration : #08c suivi du statut du dernier flux de travaux connu

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