L’article contient des recommandations, des documents de référence et des ressources pour les développeurs de Assets as a Cloud Service. Il comprend un nouveau module de chargement de ressources, des références d’API et des informations sur la prise en charge fournie dans les workflows de post-traitement.
Assets as a Cloud Service fournit plusieurs API pour interagir par programmation avec des ressources numériques. Chaque API prend en charge des cas d’utilisation spécifiques, comme indiqué dans le tableau ci-dessous. L’interface utilisateur Assets, l’application de bureau Experience Manager et Adobe Asset Link prennent en charge l’ensemble ou une partie des opérations.
Certaines API existent toujours mais ne sont pas activement prises en charge (signalées par un ×). Dans la mesure du possible, n’utilisez pas ces API.
Niveau de prise en charge | Description |
---|---|
✓ | Pris en charge |
× | Pas de prise en charge. Ne pas utiliser. |
- | Non disponible |
Cas d’utilisation | aem-upload | API Java Experience Manager / Sling / JCR | Asset Compute Service | Assets API HTTP | Servlets Sling GET / POST | GraphQL |
---|---|---|---|---|---|---|
Binaire original | ||||||
Créer l’original | ✓ | × | - | × | × | - |
Lire l’original | - | × | ✓ | ✓ | ✓ | - |
Mettre à jour l’original | ✓ | × | ✓ | × | × | - |
Supprimer l’original | - | ✓ | - | ✓ | ✓ | - |
Copier l’original | - | ✓ | - | ✓ | ✓ | - |
Déplacer l’original | - | ✓ | - | ✓ | ✓ | - |
Métadonnées | ||||||
Créer des métadonnées | - | ✓ | ✓ | ✓ | ✓ | - |
Lire les métadonnées | - | ✓ | - | ✓ | ✓ | - |
Mettre à jour les métadonnées | - | ✓ | ✓ | ✓ | ✓ | - |
Supprimer les métadonnées | - | ✓ | ✓ | ✓ | ✓ | - |
Copier les métadonnées | - | ✓ | - | ✓ | ✓ | - |
Déplacer les métadonnées | - | ✓ | - | ✓ | ✓ | - |
Fragments de contenu (CF) | ||||||
Créer un CF | - | ✓ | - | ✓ | - | - |
Lire un CF | - | ✓ | - | ✓ | - | ✓ |
Mettre à jour un CF | - | ✓ | - | ✓ | - | - |
Supprimer un CF | - | ✓ | - | ✓ | - | - |
Copier un CF | - | ✓ | - | ✓ | - | - |
Déplacer un CF | - | ✓ | - | ✓ | - | - |
Versions | ||||||
Créer une version | ✓ | ✓ | - | - | - | - |
Lire une version | - | ✓ | - | - | - | - |
Supprimer une version | - | ✓ | - | - | - | - |
Dossiers | ||||||
Créer un dossier | ✓ | ✓ | - | ✓ | - | - |
Lire un dossier | - | ✓ | - | ✓ | - | - |
Supprimer un dossier | ✓ | ✓ | - | ✓ | - | - |
Copier un dossier | ✓ | ✓ | - | ✓ | - | - |
Déplacer un dossier | ✓ | ✓ | - | ✓ | - | - |
Dans Experience Manager as a Cloud Service, vous pouvez charger directement les ressources dans l’espace de stockage cloud à l’aide de l’API HTTP. Pour charger un fichier binaire, procédez comme suit. Exécutez ces étapes dans une application externe et non dans la JVM Experience Manager.
Exécutez les étapes ci-dessus dans une application externe et non dans la JVM Experience Manager.
Cette approche permet une gestion évolutive et plus performante des chargements de ressources. Les différences par rapport à Experience Manager 6.5 sont les suivantes :
Consultez le code client pour implémenter cette approche dans la bibliothèque de chargement aem open-source.
Dans certains cas, les modifications peuvent ne pas se propager entièrement entre les requêtes à Experience Manager en raison de la nature cohérente du stockage dans Cloud Service. Cela génère des réponses 404 lors de l’initialisation ou de la complétion d’appels de téléchargement en raison de la non-propagation des créations de dossiers requises. Les client(e)s doivent s’attendre à recevoir des réponses 404 et à les gérer en implémentant une nouvelle tentative avec une stratégie backoff.
Envoyez une requête HTTP POST vers le dossier souhaité. Les ressources sont créées ou mises à jour dans ce dossier. Incluez le sélecteur .initiateUpload.json
pour indiquer que la requête est de lancer le chargement d’un fichier binaire. Par exemple, le chemin d’accès au dossier dans lequel la ressource doit être créée est /assets/folder
. La requête POST est POST https://[aem_server]:[port]/content/dam/assets/folder.initiateUpload.json
.
Le corps de la requête doit être constitué de données de formulaire application/x-www-form-urlencoded
, contenant les champs suivants :
(string) fileName
: obligatoire. Le nom de la ressource tel qu’il apparaît dans Experience Manager.(number) fileSize
: obligatoire. La taille de fichier, en octets, de la ressource en cours de chargement.Une seule requête peut être utilisée afin de lancer des chargements pour plusieurs fichiers binaires, à condition que chaque binaire contienne les champs obligatoires. En cas de succès, la requête renverra un code d’état 201
et un corps contenant des données JSON au format suivant :
{
"completeURI": "(string)",
"folderPath": "(string)",
"files": [
{
"fileName": "(string)",
"mimeType": "(string)",
"uploadToken": "(string)",
"uploadURIs": [
"(string)"
],
"minPartSize": (number),
"maxPartSize": (number)
}
]
}
completeURI
(chaîne) : appelez cet URI lorsque le chargement du fichier binaire est terminé. Il peut s’agir d’un URI absolu ou relatif, et les clients doivent être en mesure de gérer l’un ou l’autre. En d’autres termes, la valeur peut être "https://[aem_server]:[port]/content/dam.completeUpload.json"
ou "/content/dam.completeUpload.json"
; voir Fin du chargement.folderPath
(chaîne) : chemin d’accès complet au dossier dans lequel le fichier binaire est chargé.(files)
(tableau) : liste des éléments dont la longueur et l’ordre correspondent à la longueur et à l’ordre de la liste des informations binaires fournies dans la requête de lancement.fileName
(chaîne) : nom du fichier binaire correspondant, tel qu’il est fourni dans la requête de lancement. Cette valeur doit être incluse dans la requête de fin.mimeType
(chaîne) : type MIME du fichier binaire correspondant, tel qu’il est fourni dans la requête de lancement. Cette valeur doit être incluse dans la requête de fin.uploadToken
(chaîne) : jeton de chargement du fichier binaire correspondant. Cette valeur doit être incluse dans la requête de fin.uploadURIs
(tableau) : liste des chaînes dont les valeurs sont des URI complets vers lesquels le contenu du fichier binaire doit être chargé (voir Chargement d’un fichier binaire).minPartSize
(nombre) : longueur minimale, en octets, des données pouvant être fournies à l’un des uploadURIs
, s’il en existe plusieurs.maxPartSize
(nombre) : longueur maximale, en octets, des données pouvant être fournies à l’un des uploadURIs
, s’il en existe plusieurs.La sortie de lancement d’un chargement comprend une ou plusieurs valeurs d’URI de chargement. Si plusieurs URI sont fournis, le client peut diviser le fichier binaire en plusieurs parties et effectuer des requêtes PUT de chaque partie vers le fichier URI de chargement, dans l’ordre. Si vous choisissez de diviser le fichier binaire en plusieurs parties, suivez les instructions suivantes :
minPartSize
.maxPartSize
.maxPartSize
, divisez le fichier binaire en plusieurs parties pour le charger.Si la taille de votre fichier binaire est inférieure ou égale à maxPartSize
, vous pouvez plutôt charger le fichier binaire entier vers un seul URI de chargement. Si plusieurs URI de chargement sont fournis, utilisez le premier et ignorez les autres. Vous n’êtes pas tenu d’utiliser tous les URI.
Les nœuds de bordure CDN permettent d’accélérer le chargement de fichiers binaires requis.
Pour ce faire, la méthode la plus simple consiste à utiliser une partie d’une taille de maxPartSize
. Le contrat d’API garantit qu’il existe suffisamment d’URI de chargement pour charger le fichier binaire si vous utilisez une partie de cette taille. Pour ce faire, divisez le fichier binaire en parties d’une taille de maxPartSize
, en utilisant un URI pour chaque partie, dans l’ordre. La dernière partie peut avoir une taille inférieure ou égale à maxPartSize
. Par exemple, en supposant que la taille totale du fichier binaire soit de 20 000 octets, le minPartSize
est de 5 000 octets, maxPartSize
est de 8 000 octets, et le nombre d’URI de chargement est de 5. Procédez comme suit :
minPartSize
.Une erreur courante est de calculer la taille de la partie en fonction du nombre d’URI de chargement fournis par l’API. Le contrat d’API ne garantit pas que cette approche fonctionne et peut effectivement entraîner des tailles de parties qui ne sont pas comprises entre minPartSize
et maxPartSize
. Cela peut entraîner des échecs de chargement de fichiers binaires.
Encore une fois, le moyen le plus facile et le plus sûr est d’utiliser simplement des parties de taille égale à maxPartSize
.
En cas de succès du chargement, le serveur répond à chaque requête avec un code d’état 201
.
Pour plus d’informations sur l’algorithme de chargement, consultez la documentation officielle sur les fonctionnalités et la documentation de l’API dans le projet Apache Jackrabbit Oak.
Après avoir chargé toutes les parties d’un fichier binaire, envoyez une requête HTTP POST à l’URI complet fourni par les données d’initialisation. Le corps de la requête doit être constitué de données de formulaire application/x-www-form-urlencoded
, contenant les champs suivants.
Champs | Type | Requis ou non | Description |
---|---|---|---|
fileName |
Chaîne | Requis | Nom de la ressource, tel qu’il est fourni par les données de lancement. |
mimeType |
Chaîne | Requis | Type de contenu HTTP du binaire, tel qu’il est fourni par les données de lancement. |
uploadToken |
Chaîne | Requis | Jeton de chargement du binaire, tel qu’il est fourni par les données de lancement. |
createVersion |
Booléen | Facultatif | Si la valeur est définie sur True et qu’il existe une ressource portant le nom spécifié, Experience Manager crée une nouvelle version de la ressource. |
versionLabel |
Chaîne | Facultatif | Si une version est créée, le libellé associé à la nouvelle version d’une ressource. |
versionComment |
Chaîne | Facultatif | Si une version est créée, les commentaires associés à la version. |
replace |
Booléen | Facultatif | Si True et qu’une ressource portant le nom spécifié existe, Experience Manager supprime la ressource, puis la recrée. |
uploadDuration |
Nombre | Facultatif | Durée totale (en millisecondes) nécessaire pour charger le fichier dans son intégralité. Si spécifié, la durée de chargement est incluse dans les fichiers journaux du système pour l’analyse du taux de transfert. |
fileSize |
Nombre | Facultatif | Taille, en octets, du fichier. Si spécifié, la taille du fichier est incluse dans les fichiers journaux du système pour l’analyse du taux de transfert. |
Si la ressource existe et que ni createVersion
ni replace
n’est spécifié, Experience Manager met à jour la version actuelle de la ressource avec le nouveau fichier binaire.
Comme c’est le cas pour le processus de lancement, les données de la requête de fin peuvent contenir des informations pour plusieurs fichiers.
Le processus de chargement d’un binaire n’est pas terminé tant que l’URL complète n’est pas appelée pour le fichier. Une ressource est traitée une fois le processus de chargement terminé. Le traitement ne commence pas même si le fichier binaire de la ressource est complètement chargé, mais que le processus de chargement n’est pas terminé. Si le téléchargement aboutit, le serveur répond avec un code d’état 200
.
Pour en savoir plus sur les algorithmes de chargement ou pour créer vos propres scripts et outils de chargement, Adobe fournit des bibliothèques et des outils Open Source :
La bibliothèque de téléchargement d’AEM et l’outil de ligne de commande utilisent tous deux la bibliothèque node-httptransfer
La nouvelle méthode de chargement n’est prise en charge que pour Adobe Experience Manager as a Cloud Service. Les API de Adobe Experience Manager 6.5 sont obsolètes. Les méthodes liées au chargement ou à la mise à jour de ressources ou de rendus (tout chargement de binaires) sont obsolètes dans les API suivantes :
AssetManager
API Java, comme AssetManager.createAsset(..)
, AssetManager.createAssetForBinary(..)
, AssetManager.getAssetForBinary(..)
, AssetManager.removeAssetForBinary(..)
, AssetManager.createOrUpdateAsset(..)
, AssetManager.createOrReplaceAsset(..)
Dans Experience Manager, le traitement des ressources est basé sur la configuration des Profils de traitement qui utilise des microservices de ressources. Le traitement ne nécessite pas d’extensions de développeur.
Pour la configuration du workflow de post-traitement, utilisez les workflows standard avec des extensions pour les étapes personnalisées.
Si vous effectuez une mise à niveau à partir d’une version précédente d’Experience Manager, vous pouvez utiliser les microservices de ressources pour traiter les ressources. Les microservices de ressources natifs en mode cloud sont plus simples à configurer et à utiliser. Certaines étapes appliquées dans le workflow Ressource de mise à jour de la gestion des actifs numériques (DAM) de la version précédente ne sont pas prises en charge. Pour plus d’informations sur les classes prises en charge, consultez Référence de l’API Java ou Javadocs.
Les modèles de workflow techniques suivants ont été remplacés par des microservices de ressources ou la prise en charge n’est pas disponible :
com.day.cq.dam.cameraraw.process.CameraRawHandlingProcess
com.day.cq.dam.core.process.CommandLineProcess
com.day.cq.dam.pdfrasterizer.process.PdfRasterizerHandlingProcess
com.day.cq.dam.core.process.AddPropertyWorkflowProcess
com.day.cq.dam.core.process.CreateSubAssetsProcess
com.day.cq.dam.core.process.DownloadAssetProcess
com.day.cq.dam.word.process.ExtractImagesProcess
com.day.cq.dam.word.process.ExtractPlainProcess
com.day.cq.dam.ids.impl.process.IDSJobProcess
com.day.cq.dam.indd.process.INDDMediaExtractProcess
com.day.cq.dam.indd.process.INDDPageExtractProcess
com.day.cq.dam.core.impl.lightbox.LightboxUpdateAssetProcess
com.day.cq.dam.pim.impl.sourcing.upload.process.ProductAssetsUploadProcess
com.day.cq.dam.core.process.SendDownloadAssetEmailProcess
com.day.cq.dam.similaritysearch.internal.workflow.smarttags.StartTrainingProcess
com.day.cq.dam.similaritysearch.internal.workflow.smarttags.TransferTrainingDataProcess
com.day.cq.dam.switchengine.process.SwitchEngineHandlingProcess
com.day.cq.dam.core.process.GateKeeperProcess
com.day.cq.dam.s7dam.common.process.DMEncodeVideoWorkflowCompletedProcess
com.day.cq.dam.core.process.DeleteImagePreviewProcess
com.day.cq.dam.video.FFMpegTranscodeProcess
com.day.cq.dam.core.process.ThumbnailProcess
com.day.cq.dam.video.FFMpegThumbnailProcess
com.day.cq.dam.core.process.CreateWebEnabledImageProcess
com.day.cq.dam.core.process.CreatePdfPreviewProcess
com.day.cq.dam.s7dam.common.process.VideoUserUploadedThumbnailProcess
com.day.cq.dam.s7dam.common.process.VideoThumbnailDownloadProcess
com.day.cq.dam.s7dam.common.process.VideoProxyServiceProcess
com.day.cq.dam.scene7.impl.process.Scene7UploadProcess
com.day.cq.dam.s7dam.common.process.S7VideoThumbnailProcess
com.day.cq.dam.core.process.MetadataProcessorProcess
com.day.cq.dam.core.process.AssetOffloadingProcess
com.adobe.cq.dam.dm.process.workflow.DMImageProcess
Voir également