Version | Lien de l’article |
---|---|
AEM 6.5 | Cliquez ici |
AEM as a Cloud Service | Cet article |
L’API HTTP Assets permet d’effectuer des opérations CRUD (créer, lire, mettre à jour, supprimer) sur des ressources numériques, notamment les métadonnées, les rendus et les commentaires, ainsi que sur des contenus structurés grâce à des fragments de contenu Experience Manager. Elle est exposée sous /api/assets
et est implémentée en tant qu’API REST. Elle comprend Prise en charge des fragments de contenu.
Pour accéder à l’API :
https://[hostname]:[port]/api.json
.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 de PDF. Reposez sur le code de réponse pour une analyse ou des actions plus approfondies.
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.
Un fragment de contenu est un type de ressource spécial. Il permet d’accéder aux données structurées, telles que les textes, les nombres, les dates, etc. Comme il existe plusieurs différences de 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 .
L’API HTTP d’Assets présente deux éléments principaux : des dossiers et des ressources (pour les ressources standard). Il expose également des éléments plus détaillés pour les modèles de données personnalisés décrivant le contenu structuré dans les fragments de contenu. Pour plus d’informations, consultez Modèles de données de fragments de contenu.
Les dossiers sont comparables aux répertoires dans les systèmes de fichiers traditionnels. Le dossier peut contenir uniquement des ressources, uniquement des dossiers, ou des dossiers et des ressources. 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
est le nom du dossier. Il est identique au dernier segment du chemin d’URL, sans l’extension.title
est un titre facultatif du dossier pouvant être affiché au lieu de son nom.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 lui-même.parent
: lien vers le dossier parent.thumbnail
: (facultatif) lien vers une miniature de dossier.Dans Experience Manager, une ressource contient les éléments suivants :
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.
Dans Experience Manager, un dossier comprend les composants suivants :
L’API HTTP d’Assets offre les fonctionnalités suivantes :
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è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 :
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é, les clients doivent récupérer le contenu de l’URL vers laquelle pointe le lien avec l’élément rel
self
.
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 :
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 :
Pour plus d’informations sur la création d’une ressource, consultez Chargement de ressources. Vous ne pouvez pas créer de ressource à l’aide de l’API HTTP.
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.
Met à jour les propriétés de métadonnées d’une ressource. Si vous mettez à jour une propriété du namespace dc:
, l’API met à jour cette même propriété dans le namespace jcr
. L’API ne synchronise pas les propriétés des deux namespaces.
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 :
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 name
pour le nom du rendu et file
pour la référence au fichier.
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
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 :
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 :
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 :
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 :
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 :
Après l’heure de désactivation, une ressource et ses rendus ne sont plus disponibles via l’interface web Assets ni par le biais de l’API HTTP. L’API renvoie un message d’erreur 404 si l’heure d’activation se situe dans le futur ou si l’heure de désactivation se situe dans le passé.
L’API HTTP Assets ne renvoie pas les métadonnées complètes. 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
.
Voir également