Documentation AEM as a Cloud Service Guide de l’utilisateur

Gestion des ressources numériques à l’aide de l’API HTTP Adobe Experience Manager Assets

Dernière mise à jour : 22 mars 2025

Rubriques :
API Assets HTTP

Créé pour :

Développeur
Administration

^Nouveau Dynamic Media Prime et Ultimate	^Nouveau AEM Assets Ultimate	^Nouvelle Intégration d’AEM Assets à Edge Delivery Services	^Nouveau Extensibilité de l’interface utilisateur	^Nouveau Activation de Dynamic Media Prime et Ultimate
Bonnes pratiques de recherche	Bonnes pratiques relatives aux métadonnées	Hub de contenus	Fonctionnalités Dynamic Media avec OpenAPI	Documentation de développement pour AEM Assets

Version	Lien de l’article
AEM 6.5	Cliquez ici
AEM as a Cloud Service	Cet article

Prise en main de l’API HTTP Assets d’AEM

L’API HTTP Assets d’AEM permet d’effectuer des opérations CRUD (créer, lire, mettre à jour et supprimer) sur des ressources numériques par le biais d’une interface REST disponible à l’adresse /api/assets. Ces opérations s’appliquent aux métadonnées, rendus et commentaires des ressources. Elle comprend la prise en charge des fragments de contenu.

NOTE

Une implémentation OpenAPI modernisée de l’API de gestion des fragments de contenu est disponible. Pour consulter la documentation complète, voir API de gestion des fragments de contenu. Il est recommandé d’utiliser la nouvelle implémentation d’OpenAPI. L’utilisation existante de l’API HTTP Assets pour les fragments de contenu doit être migrée vers la nouvelle API ouverte de gestion des fragments de contenu.

Pour accéder à l’API :

Ouvrez le document du service API à l’adresse https://[hostname]:[port]/api.json.
Suivez le lien du service Assets pointant vers https://[hostname]:[server]/api/assets.json.

La réponse de l’API est un fichier JSON pour certains types MIME et un code de réponse pour tous les types MIME. La réponse JSON est facultative et peut ne pas être disponible, par exemple pour les fichiers PDF. Fiez-vous au code de réponse pour une analyse ou des actions supplémentaires.

NOTE

Tous les appels d’API liés au chargement ou à la mise à jour des ressources ou des fichiers binaires en général (tels que les rendus) sont obsolètes pour un déploiement d’Experience Manager as a Cloud Service. Pour charger des fichiers binaires, utilisez plutôt des API de chargement binaire direct.

Gestion des fragments de contenu

Un fragment de contenu est une ressource structurée qui stocke du texte, des nombres et des dates. Comme il existe plusieurs différences avec les ressources standard (telles que les images ou les documents), certaines règles supplémentaires s’appliquent pour gérer les fragments de contenu.

Pour plus d’informations, consultez Prise en charge de fragments de contenu dans l’API HTTP d’ Experience Manager Assets.

NOTE

Consultez API AEM pour la diffusion et la gestion de contenu structuré pour un aperçu des différentes API disponibles et une comparaison de certains des concepts impliqués.

Les OpenAPI de modèle de fragment de contenu et de fragment de contenu sont également disponibles.

Examiner le modèle de données

L’API HTTP Assets expose principalement deux éléments : des dossiers et des ressources standard. Elle fournit également des éléments détaillés pour les modèles de données personnalisés utilisés dans les fragments de contenu. Pour plus d’informations, voir Modèles de données de fragments de contenu. Pour plus d’informations, consultez Modèles de données de fragments de contenu.

NOTE

Les OpenAPI de modèle de fragment de contenu et de fragment de contenu sont également disponibles.

Gestion des dossiers

Les dossiers sont comparables aux répertoires dans les systèmes de fichiers traditionnels. Les dossiers peuvent contenir des ressources, des sous-dossiers, ou les deux. Les dossiers se composent des éléments suivants :

Entités : les entités d’un dossier sont ses éléments enfants qui peuvent, à leur tour, être des dossiers et des ressources.

Propriétés :

name : nom du dossier (dernier segment du chemin de l’URL, sans l’extension).
title : un titre facultatif s’affiche à la place du nom du dossier.

NOTE

Certaines propriétés de dossier ou de ressource sont associées à un préfixe différent. Le préfixe jcr de jcr:title, jcr:description et jcr:language est remplacé par le préfixe dc. Par conséquent, dans le JSON renvoyé, dc:title et dc:description contiennent respectivement les valeurs de jcr:title et jcr:description.

Les dossiers Liens présentent trois liens :

self : lien vers le dossier lui-même.
parent : lien vers le dossier parent.
thumbnail (facultatif) : lien vers une image miniature de dossier.

Gestion des ressources

Dans Experience Manager, une ressource contient les éléments suivants :

Propriétés et métadonnées : informations descriptives sur la ressource.
Fichier binaire : fichier chargé à l’origine.
Rendus : plusieurs rendus configurés (images de différentes tailles, différents codages vidéo ou pages extraites de fichiers PDF/Adobe InDesign, par exemple).
Commentaires (facultatif) : remarques fournies par l’utilisateur.

Pour plus d’informations sur les éléments des fragments de contenu, voir Prise en charge de fragments de contenu dans l’API HTTP Experience Manager Assets.

NOTE

Les OpenAPI de modèle de fragment de contenu et de fragment de contenu sont également disponibles.

Dans Experience Manager, un dossier comprend les composants suivants :

Entités : les enfants des ressources sont ses rendus.
Propriétés.
Liens.

Explorer les opérations d’API disponibles

L’API HTTP d’Assets offre les fonctionnalités suivantes :

Récupérer une liste de dossiers
Créer un dossier
Créer une ressource (obsolète)
Mettre à jour le fichier binaire d’une ressource (obsolète)
Mettre à jour les métadonnées d’une ressource
Créer un rendu de ressource
Mettre à jour un rendu de ressource
Créer un commentaire de ressource
Copier un dossier ou une ressource
Déplacer un dossier ou une ressource
Supprimer un dossier, une ressource ou un rendu

NOTE

Pour faciliter la lecture, les notations cURL complètes ne sont pas utilisées dans les exemples suivants. La notation correspond à Resty qui est un wrapper de script pour cURL.

Récupérer une liste de dossiers

Récupère une représentation Siren d’un dossier existant et de ses entités enfants (sous-dossiers ou ressources).

Requête : GET /api/assets/myFolder.json

Codes de réponse : les codes de réponse sont les suivants :

200 – OK – succès.
404 – INTROUVABLE – le dossier n’existe pas ou n’est pas accessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Réponse : la classe de l’entité renvoyée est une ressource ou un dossier. Les propriétés des entités contenues représentent un sous-ensemble du jeu complet des propriétés de chaque entité. Pour obtenir une représentation complète de l’entité, la clientèle doit récupérer le contenu de l’URL vers laquelle pointe le lien avec l’élément rel self.

Créer un dossier

Crée un dossier sling : OrderedFolder à l’emplacement indiqué. Si * est indiqué au lieu d’un nom de nœud, le servlet utilisera le nom du paramètre comme nom de nœud. La requête accepte l’une des conditions suivantes :

Représentation Siren du nouveau dossier
Ensemble de paires nom-valeur, codées sous la forme application/www-form-urlencoded ou multipart/ form- data. Ces fonctions sont utiles pour créer un dossier directement à partir d’un formulaire HTML.

Les propriétés du dossier peuvent, en outre, être spécifiées en tant que paramètres de requête URL.

Un appel d’API échoue avec un code de réponse 500 si le nœud parent du chemin d’accès fourni n’existe pas. Un appel renvoie un code de réponse 409 si le dossier existe.

Paramètres : name est le nom du dossier.

Requête

POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"title":"My Folder"}}'
POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

Codes de réponse : les codes de réponse sont les suivants :

201 – CRÉÉ – en cas de réussite de la création.
409 – CONFLIT – si un dossier existe.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Créer une ressource

La création de ressources n’est pas prise en charge via cette API HTTP. Pour la création de ressources, utilisez l’API chargement de ressources.

Mettre à jour un fichier binaire de ressource

Pour plus d’informations sur la mise à jour de fichiers binaires de ressources, consultez Chargement de ressources. Vous ne pouvez pas mettre à jour un fichier binaire de ressources à l’aide de l’API HTTP.

Mettre à jour les métadonnées d’une ressource

Cette opération met à jour les métadonnées de la ressource. Lors de la mise à jour des propriétés dans l’espace de noms dc:, la propriété jcr: correspondante est mise à jour. Toutefois, l’API ne synchronise pas les propriétés sous les deux espaces de noms.

Requête : PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"dc:title":"My Asset"}}'

Codes de réponse : les codes de réponse sont les suivants :

200 – OK – si la ressource a été mise à jour avec succès.
404 – INTROUVABLE – si la ressource n’a pas été trouvée ou est inaccessible à l’aide de l’URI fourni.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Créer un rendu de ressource

Créer un rendu pour une ressource. Si le nom de paramètre de requête n’est pas fourni, le nom de fichier est utilisé comme nom du rendu.

Paramètres : les paramètres sont les suivants :

name : pour le nom du rendu.
file : fichier binaire pour le rendu comme référence.

Requête

POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"
POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

Codes de réponse

201 – CRÉÉ – si le rendu a été créé avec succès.
404 – INTROUVABLE – si la ressource n’a pas été trouvée ou est inaccessible à l’aide de l’URI fourni.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Mettre à jour un rendu de ressource

Met à jour et remplace le rendu d’une ressource par les nouvelles données binaires.

Requête : PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

Codes de réponse : les codes de réponse sont les suivants :

200 – OK – si le rendu a été mis à jour avec succès.
404 – INTROUVABLE – si la ressource n’a pas été trouvée ou est inaccessible à l’aide de l’URI fourni.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Ajouter un commentaire pour une ressource

Paramètres : les paramètres sont message pour le corps de message du commentaire et annotationData pour les données d’annotation au format JSON.

Requête : POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

Codes de réponse : les codes de réponse sont les suivants :

201 – CRÉÉ – si le commentaire a été créé avec succès.
404 – INTROUVABLE – si la ressource n’a pas été trouvée ou est inaccessible à l’aide de l’URI fourni.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Copier un dossier ou une ressource

Copie un fichier ou une ressource disponible à l’emplacement indiqué vers une nouvelle destination.

En-têtes de la requête : les paramètres sont les suivants :

X-Destination – un nouvel URI de destination appartenant à la portée de la solution d’API pour copier la ressource.
X-Depth – infinity ou 0. L’utilisation du code 0 entraîne la copie exclusive de la ressource et de ses propriétés, mais pas de ses enfants.
X-Overwrite – utilisez le code F pour éviter le remplacement d’une ressource à la destination existante.

Requête : COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

Codes de réponse : les codes de réponse sont les suivants :

201 – CRÉÉ – si le dossier ou la ressource a été copié vers une destination inexistante.
204 – AUCUN CONTENU – si le dossier ou la ressource a été copié vers une destination existante.
412 – ÉCHEC DE LA PRÉCONDITION – s’il manque un en-tête de requête.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Déplacer un dossier ou une ressource

Déplace un dossier ou une ressource de l’emplacement indiqué vers une nouvelle destination.

En-têtes de la requête : les paramètres sont les suivants :

X-Destination – un nouvel URI de destination appartenant à la portée de la solution d’API pour copier la ressource.
X-Depth – infinity ou 0. L’utilisation du code 0 entraîne la copie exclusive de la ressource et de ses propriétés, mais pas de ses enfants.
X-Overwrite – Utiliser soit T pour forcer la suppression d’une ressource existante, soit F pour éviter le remplacement d’une ressource existante.

Requête : MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

Codes de réponse : les codes de réponse sont les suivants :

201 – CRÉÉ – si le dossier ou la ressource a été copié vers une destination inexistante.
204 – AUCUN CONTENU – si le dossier ou la ressource a été copié vers une destination existante.
412 – ÉCHEC DE LA PRÉCONDITION – s’il manque un en-tête de requête.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Supprimer un dossier, une ressource ou un rendu

Supprime une ressource (arborescence) pour le chemin indiqué.

Requête

DELETE /api/assets/myFolder
DELETE /api/assets/myFolder/myAsset.png
DELETE /api/assets/myFolder/myAsset.png/renditions/original

Codes de réponse : les codes de réponse sont les suivants :

200 – OK – si le dossier a été supprimé avec succès.
412 – ÉCHEC DE LA PRÉCONDITION – si la collection racine est introuvable ou inaccessible.
500 – ERREUR INTERNE DU SERVEUR – si une autre erreur s’est produite.

Respect des bonnes pratiques et des limites de notes

Assets et ses rendus ne sont plus disponibles via l’interface web Assets et l’API HTTP lorsque l’heure de est atteinte L’API renvoie une erreur 404 si l’Heure d’activation est dans le futur ou l’Heure de désactivation est dans le passé.
L’API HTTP Assets renvoie uniquement un sous-ensemble de métadonnées. Les espaces de noms sont codés en dur et seuls ces espaces de noms sont renvoyés. Pour obtenir des métadonnées complètes, consultez le chemin d’accès à la ressource /jcr_content/metadata.json.
Certaines propriétés de dossier ou de ressource sont associées à un préfixe différent lors de la mise à jour à l’aide d’API. Le préfixe jcr de jcr:title, jcr:description et jcr:language est remplacé par le préfixe dc. Par conséquent, dans le JSON renvoyé, dc:title et dc:description contiennent respectivement les valeurs de jcr:title et jcr:description.

Explorer les ressources associées

recommendation-more-help