API HTTP Asset Compute Service asset-compute-http-api

L’utilisation de l’API est limitée à des fins de développement. L’API est fournie à titre de contexte pour le développement d’applications personnalisées. Adobe Experience Manager as a Cloud Service utilise l’API pour transmettre les informations de traitement à une application personnalisée. Pour plus d’informations, voir Utilisation des microservices de ressources et des profils de traitement.

Toute personne cliente de l’API HTTP Asset Compute Service doit appliquer ce flux de haut niveau :

Le module adobe-asset-compute-client facilite l’utilisation de l’API dans le code Node.js.

Authentification et autorisation authentication-and-authorization

Toutes les API nécessitent une authentification par jeton d’accès. Les requêtes doivent définir les en-têtes suivants :

Portées scopes

Vérifiez les portées suivantes pour le jeton d’accès :

Ces portées nécessitent que le projet Adobe Developer Console souscrive aux services Asset Compute, I/O Events et I/O Management API. La répartition des portées individuelles est la suivante :

Enregistrement register

Chaque personne cliente d’Asset Compute service (un projet Adobe Developer Console unique, abonné au service) doit s’enregistrer avant de procéder à des demandes de traitement. L’étape d’enregistrement renvoie le journal unique des événements, nécessaire pour récupérer les événements asynchrones issus du traitement du rendu.

À la fin de son cycle de vie, une personne cliente peut annuler son enregistrement.

Demande d’enregistrement register-request

Cet appel d’API configure une personne cliente Asset Compute et fournit l’URL du journal des événements. Ce processus est une opération idempotente (c’est-à-dire ayant le même effet si elle est appliquée une ou plusieurs fois), qui ne doit être appelée qu’une seule fois pour chaque personne cliente. Elle peut être de nouveau appelée pour récupérer l’URL du journal.

Réponse à l’enregistrement register-response

Les codes d’état HTTP sont les suivants :

Requête d’annulation d’enregistrement unregister-request

Cet appel d’API annule l’enregistrement d’une personne cliente Asset Compute. Après l’annulation de cet enregistrement, il n’est plus possible d’appeler /process. L’utilisation de l’appel d’API, pour un client non enregistré ou un client à enregistrer, renvoie une erreur 404.

Réponse à l’annulation de l’enregistrement unregister-response

Les codes d’état sont les suivants :

Requête de traitement process-request

L’opération process lance une tâche chargée de transformer une ressource source en plusieurs rendus, en fonction des instructions contenues dans la requête. Des notifications de succès de l’exécution (type d’événement rendition_created) ou d’erreur (type d’événement rendition_failed) sont envoyées à un journal des événements. Celui-ci doit être récupéré en utilisant une fois /register avant de lancer un nombre quelconque de requêtes /process. Les requêtes incorrectement formulées échouent immédiatement avec un code d’erreur 400.

Les fichiers binaires sont référencés à l’aide d’URL, telles que les URL présignées Amazon AWS S3 ou les URL de stockage Blob Azure SAS. Utilisé pour lire la ressource source (URL GET) et écrire les rendus (URL PUT). Il appartient au client de générer ces URL présignées.

Requête de traitement JSON process-request-json

Le corps de la requête de /process est un objet JSON dont le schéma est le suivant :

{
    "source": "",
    "renditions" : []
}

Les champs disponibles sont les suivants :

La source peut être soit une chaîne <string>, considérée comme une URL, ou un objet (<object>) avec un champ supplémentaire. Les variantes suivantes sont similaires :

"source": "http://example.com/image.jpg"

"source": {
    "url": "http://example.com/image.jpg"
}

Champs d’objet source source-object-fields

Exemple de requête process complète complete-process-request-example

{
    "source": "https://www.adobe.com/content/dam/acom/en/lobby/lobby-bg-bts2017-logged-out-1440x860.jpg",
    "renditions" : [{
            "name": "image.48x48.png",
            "target": "https://some-presigned-put-url-for-image.48x48.png",
            "fmt": "png",
            "width": 48,
            "height": 48
        },{
            "name": "image.200x200.jpg",
            "target": "https://some-presigned-put-url-for-image.200x200.jpg",
            "fmt": "jpg",
            "width": 200,
            "height": 200
        },{
            "name": "cqdam.xmp.xml",
            "target": "https://some-presigned-put-url-for-cqdam.xmp.xml",
            "fmt": "xmp"
        },{
            "name": "cqdam.text.txt",
            "target": "https://some-presigned-put-url-for-cqdam.text.txt",
            "fmt": "text"
    }]
}

Réponse du traitement process-response

La requête /process renvoie immédiatement un succès ou un échec en fonction de la validation de la requête de base. Le traitement des ressources se produit de manière asynchrone.

Codes d’état :

La plupart des clientes et des clients sont susceptibles de réessayer la même requête avec un backoff exponentiel suite à une erreur, à l’exception des problèmes de configuration, comme 401 ou 403, ou des requêtes non valides comme 400. Outre la limitation du débit normal par le biais de réponses 429, une interruption ou une limitation de service temporaire peut entraîner des erreurs 5xx. Il est dans ce cas conseillé de réessayer après un certain temps.

Toutes les réponses JSON (le cas échéant) incluent la valeur requestId, identique à celle de l’en-tête X-Request-Id. Adobe recommande la lecture à partir de l’en-tête, car il est toujours présent. La valeur requestId est également renvoyée dans tous les événements relatifs aux requêtes de traitement sous la forme requestId. Les clientes et clients ne doivent pas présumer du format de cette chaîne. Il s’agit d’un identifiant de chaîne opaque.

Souscrire au post-traitement opt-in-to-post-processing

Le SDK Asset Compute prend en charge un ensemble d’options de base pour le post-traitement d’images. Les programmes de travail personnalisés peuvent explicitement souscrire au post-traitement en définissant le champ postProcess de l’objet de rendu sur true.

Les cas d’utilisation pris en charge sont les suivants :

Mise en filigrane de ressources add-watermark

Le SDK Asset Compute prend en charge l’ajout d’un filigrane aux fichiers d’image PNG, JPEG, TIFF et GIF. Le filigrane est ajouté à la suite des instructions de rendu dans l’objet watermark.

Le filigrane est appliqué pendant le post-traitement du rendu. Pour les ressources de filigrane, le programme de travail personnalisé opte pour le post-traitement en définissant le champ postProcess de l’objet de rendu sur true. Si l’utilisateur ou l’utilisatrice ne souscrit pas, le filigrane n’est pas appliqué, même si, dans la requête, l’objet de filigrane est défini sur l’objet de rendu.

Instructions de rendu rendition-instructions

Les options suivantes sont disponibles pour le tableau renditions dans /process.

Champs communs common-fields

Champs spécifiques au rendu rendition-specific-fields

Pour obtenir la liste des formats de fichiers actuellement pris en charge, voir Formats de fichiers pris en charge.

Champs spécifiques aux filigranes watermark-specific-fields

Le format PNG est utilisé comme filigrane.

Événements asynchrones asynchronous-events

Une fois le traitement d’un rendu terminé ou si une erreur se produit, un événement est envoyé à un I/O Events Journal Adobe. Les clientes et clients doivent écouter l’URL du journal fournie par le biais de /register. La réponse du journal comprend un tableau event constitué d’un objet pour chaque événement, dont le champ event contient le payload réel de l’événement.

Le type I/O Events Adobe pour tous les événements d’Asset Compute Service est asset_compute. Le journal est automatiquement abonné exclusivement à ce type d’événement et il n’est pas nécessaire d’effectuer un filtrage en fonction du type Événement Adobe Developer. Les types d’événements spécifiques au service sont disponibles dans la propriété type de l’événement.

Types d’événements event-types

Attributs d’événement event-attributes

Métadonnées metadata

Raisons de l’erreur error-reasons