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.

NOTE
Asset Compute Service est disponible uniquement pour une utilisation avec Experience Manager as a Cloud Service.

Tout client de l’API HTTP Asset Compute Service doit appliquer ce flux de haut niveau :

  1. Un client est configuré en tant que projet Adobe Developer Console dans une organisation IMS. Chaque client (système ou environnement) distinct a besoin de son propre projet pour séparer le flux de données d’événement.

  2. Un client génère un jeton d’accès pour le compte technique à l’aide de l’authentification JWT (compte de service).

  3. Un client n’appelle /register qu’une seule fois pour récupérer l’URL du journal.

  4. Un client appelle /process pour chaque ressource pour laquelle il souhaite générer des rendus. L’appel est asynchrone.

  5. Un client interroge régulièrement le journal pour recevoir des événements. Il reçoit des événements pour chaque rendu demandé et traité (type d’événement rendition_created) ou en cas d’erreur (type d’événement rendition_failed).

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 :

  1. En-tête Authorization avec jeton support, qui est le jeton de compte technique, reçu par le biais d’un échange JWT issu du projet Adobe Developer Console. Les portées sont décrites ci-dessous.

  2. En-tête x-gw-ims-org-id avec l’ID d’organisation IMS.

  3. x-api-key avec l’ID client du projet Adobe Developers Console.

Portées scopes

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

  • openid
  • AdobeID
  • asset_compute
  • read_organizations
  • event_receiver
  • event_receiver_api
  • adobeio_api
  • additional_info.roles
  • additional_info.projectedProductContext

Pour cela, le projet Adobe Developer Console doit être abonné aux services Asset Compute, I/O Events et I/O Management API. La répartition des portées individuelles est la suivante :

  • De base

    • Portées : openid,AdobeID
  • Asset Compute

    • Metascope : asset_compute_meta
    • Portées : asset_compute,read_organizations
  • Adobe I/O Événements

    • Metascope : event_receiver_api
    • Portées : event_receiver,event_receiver_api
  • API de gestion Adobe I/O

    • Metascope : ent_adobeio_sdk
    • Portées : adobeio_api,additional_info.roles,additional_info.projectedProductContext

L’enregistrement register

Chaque client 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, un client peut annuler son enregistrement.

Demande d’enregistrement register-request

Cet appel d’API configure un client Asset Compute et fournit l’URL du journal des événements. Il s’agit d’une opération idempotente (c.-à-d. 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 client. Elle peut être de nouveau appelée pour récupérer l’URL du journal.

Paramètre
Valeur
Méthode
POST
Chemin
/register
En-tête Authorization
Tous les en-têtes relatifs aux autorisations.
En-tête x-request-id
Facultatif. Il peut être défini par les clients pour un identifiant unique de bout en bout des demandes de traitement sur l’ensemble des systèmes.
Corps de la requête
Doit être vide.

Réponse à l’enregistrement register-response

Paramètre
Valeur
Type MIME
application/json
En-tête X-Request-Id
Identique à l’en-tête de la requête X-Request-Id ou à celui généré de manière unique. Sert à identifier les requêtes entre systèmes et/ou les demandes d’assistance.
Corps de la réponse
Objet JSON contenant les champs journal, ok et/ou requestId.

Les codes d’état HTTP sont les suivants :

  • 200 Success  : lorsque la requête est acceptée. Contient l’URL de journal qui doit notifiée des résultats du traitement asynchrone déclenché par /process (avec un type d’événement rendition_created en cas de réussite, ou rendition_failed en cas d’échec).

    code language-json
    {
        "ok": true,
        "journal": "https://api.adobe.io/events/organizations/xxxxx/integrations/xxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "requestId": "1234567890"
    }
    
  • 401 Unauthorized  : survient lorsque la requête ne dispose pas d’une authentification valide. Il peut s’agir, par exemple, d’un jeton d’accès ou d’une clé d’API non valide.

  • 403 Forbidden  : survient lorsque la demande ne dispose pas d’une autorisation valide. Par exemple, si le jeton d’accès est valide, mais que le projet Adobe Developer Console (compte technique) n’est pas abonné à tous les services requis.

  • 429 Too many requests  : survient lorsque le système est surchargé de requêtes issues de ce client ou autres. Les clients doivent effectuer un nouvel essai avec un backoff exponentiel (pour diminuer la fréquence du processus). Le corps est vide.

  • Error 4xx  : survient en cas d’erreur client, quelle qu’elle soit, et d’échec de l’enregistrement. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    
  • Error 5xx  : survient en cas d’erreur côté serveur, quelle qu’elle soit, et d’échec de l’enregistrement. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    

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

Cet appel d’API annule l’enregistrement d’un client Asset Compute. Après cela, 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.

Paramètre
Valeur
Méthode
POST
Chemin
/unregister
En-tête Authorization
Tous les en-têtes relatifs aux autorisations.
En-tête x-request-id
Facultatif. Il peut être défini par les clients pour un identifiant unique de bout en bout des demandes de traitement sur l’ensemble des systèmes.
Corps de la requête
Vide.

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

Paramètre
Valeur
Type MIME
application/json
En-tête X-Request-Id
Identique à l’en-tête de la requête X-Request-Id ou à celui généré de manière unique. Sert à identifier les requêtes entre systèmes et/ou les demandes d’assistance.
Corps de la réponse
Objet JSON contenant les champs ok et requestId.

Les codes d’état sont les suivants :

  • 200 Success  : survient lorsque l’enregistrement et le journal sont trouvés et supprimés.

    code language-json
    {
        "ok": true,
        "requestId": "1234567890"
    }
    
  • 401 Unauthorized  : survient lorsque la requête ne dispose pas d’une authentification valide. Il peut s’agir, par exemple, d’un jeton d’accès ou d’une clé d’API non valide.

  • 403 Forbidden  : survient lorsque la demande ne dispose pas d’une autorisation valide. Par exemple, si le jeton d’accès est valide, mais que le projet Adobe Developer Console (compte technique) n’est pas abonné à tous les services requis.

  • 404 Not found  : survient lorsqu’il n’existe aucun enregistrement en cours pour les informations d’identification données.

    code language-json
    {
        "ok": true,
        "requestId": "1234567890"
    }
    
  • 429 Too many requests  : survient lorsque le système est surchargé. Les clients doivent effectuer un nouvel essai avec un backoff exponentiel (pour diminuer la fréquence du processus). Le corps est vide.

  • Error 4xx  : survient lorsqu’une autre erreur client s’est produite et que l’annulation de l’enregistrement a échoué. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    
  • Error 5xx  : survient en cas d’erreur côté serveur, quelle qu’elle soit, et d’échec de l’enregistrement. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    

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 contenus binaires sont référencés à l’aide d’URL, par exemple des URL présignées Amazon AWS S3 ou Azure Blob Storage SAS, à la fois pour la lecture de la ressource source (URL GET) et l’écriture des rendus (URL PUT). Il appartient au client de générer ces URL présignées.

Paramètre
Valeur
Méthode
POST
Chemin
/process
Type MIME
application/json
En-tête Authorization
Tous les en-têtes relatifs aux autorisations.
En-tête x-request-id
Facultatif. Il peut être défini par les clients pour un identifiant unique de bout en bout des demandes de traitement sur l’ensemble des systèmes.
Corps de la requête
Doit être au format JSON de requête de traitement comme décrit ci-dessous. Il fournit des instructions sur la ressource à traiter et les rendus à générer.

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 :

Nom
Type
Description
Exemple
source
string
URL de la ressource source à traiter. Facultatif, en fonction du format de rendu demandé (ex. fmt=zip).
"http://example.com/image.jpg"
source
object
Description de la ressource source à traiter. Voir la description des champs d’objet source ci-dessous. Facultatif, en fonction du format de rendu demandé (ex. fmt=zip).
{"url": "http://example.com/image.jpg", "mimeType": "image/jpeg" }
renditions
array
Rendus à générer à partir du fichier source. Chaque objet de rendu prend en charge l’instruction de rendu. Requis.
[{ "target": "https://....", "fmt": "png" }]

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

Nom
Type
Description
Exemple
url
string
URL de la ressource source à traiter. Requis.
"http://example.com/image.jpg"
name
string
Nom du fichier de ressource source. L’extension de fichier du nom peut être utilisée si aucun type MIME ne peut être détecté. Prévaut sur le nom de fichier dans le chemin d’URL ou dans l’en-tête content-disposition de la ressource binaire. La valeur par défaut est « file ».
"image.jpg"
size
number
Taille du fichier source en octets. Prévaut sur l’en-tête content-length de la ressource binaire.
10234
mimetype
string
Type MIME du fichier de ressource source. Prévaut sur l’en-tête content-type de la ressource binaire.
"image/jpeg"

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.

Paramètre
Valeur
Type MIME
application/json
En-tête X-Request-Id
Identique à l’en-tête de la requête X-Request-Id ou à celui généré de manière unique. Sert à identifier les requêtes entre systèmes et/ou les demandes d’assistance.
Corps de la réponse
Objet JSON contenant les champs ok et requestId.

Codes d’état :

  • 200 Success  : si la demande a été envoyée avec succès. La réponse JSON comprend "ok": true :

    code language-json
    {
        "ok": true,
        "requestId": "1234567890"
    }
    
  • 400 Invalid request  : si la requête n’est pas correctement formulée, par exemple s’il manque des champs obligatoires dans le fichier JSON de la requête. La réponse JSON comprend "ok": false :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    
  • 401 Unauthorized  : lorsque la requête ne dispose pas d’une authentification valide. Il peut s’agir, par exemple, d’un jeton d’accès ou d’une clé d’API non valide.

  • 403 Forbidden  : lorsque la demande ne dispose pas d’une autorisation valide. Par exemple, si le jeton d’accès est valide, mais que le projet Adobe Developer Console (compte technique) n’est pas abonné à tous les services requis.

  • 429 Too many requests  : lorsque le système est surchargé de requêtes issues de ce client ou en général. Les clients peuvent effectuer un nouvel essai avec un backoff exponentiel (pour diminuer la fréquence du processus). Le corps est vide.

  • Error 4xx  : en cas d’erreur client, quelle qu’elle soit. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    
  • Error 5xx  : survient en cas d’erreur côté serveur, quelle qu’elle soit. Généralement, une réponse JSON de ce type est renvoyée, même si ce n’est pas garanti pour toutes les erreurs :

    code language-json
    {
        "ok": false,
        "requestId": "1234567890",
        "message": "error message"
    }
    

La plupart 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. Il est recommandé de lire les informations contenues dans l’en-tête, puisqu’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 clients ne doivent pas présumer du format de cette chaîne, car il s’agit d’un identifiant de chaîne opaque.

Souscription 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 :

  • Recadrer un rendu pour obtenir un rectangle dont les limites sont définies par crop.w, crop.h, crop.x et crop.y. L’opération est définie par instructions.crop dans l’objet de rendu.
  • Redimensionner les images en utilisant la largeur, la hauteur ou les deux. L’opération est définie par instructions.width et instructions.height dans l’objet de rendu. Pour redimensionner une image en utilisant uniquement la largeur ou la hauteur, définissez une seule valeur. Compute Service conserve les proportions.
  • Définir la qualité d’une image JPEG. L’opération est définie par instructions.quality dans l’objet de rendu. La meilleure qualité est indiquée par 100 et les valeurs inférieures correspondent à une qualité réduite.
  • Créer des images entrelacées. L’opération est définie par instructions.interlace dans l’objet de rendu.
  • Définir la résolution en ppp pour ajuster la taille des rendus à des fins de publication sur ordinateur en ajustant l’échelle appliquée aux pixels. L’opération est définie par instructions.dpi dans l’objet de rendu pour modifier la résolution en ppp. Cependant, pour redimensionner l’image afin qu’elle ait la même taille, mais avec une résolution différente, utilisez les instructions convertToDpi.
  • Redimensionner l’image pour que sa largeur ou sa hauteur de rendu reste identique à celle de l’image d’origine avec la résolution cible (ppp) spécifiée. L’opération est définie par instructions.convertToDpi dans l’objet de rendu.

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 n’accepte 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

Il s’agit des options disponibles pour le tableau renditions dans /process.

Champs communs common-fields

Nom
Type
Description
Exemple
fmt
string
Le format de cible des rendus peut également être text pour l’extraction de texte et xmp pour l’extraction de métadonnées XMP au format xml. Voir Formats pris en charge
png
worker
string
URL d’une application personnalisée. Doit être une URL https://. Si ce champ est présent, le rendu est créé par une application personnalisée. Tout autre champ de rendu défini est ensuite utilisé dans l’application personnalisée.
"https://1234.adobeioruntime.net
/api/v1/web
/example-custom-worker-master/worker"
target
string
URL vers laquelle le rendu généré doit être téléchargé à l’aide de PUT HTTP.
http://w.com/img.jpg
target
object

Informations de chargement d’URL présignées en plusieurs parties pour le rendu généré. Il s’agit d’un chargement AEM/Oak Direct Binary Upload avec ce comportement de chargement en plusieurs parties.
Champs :

  • urls : tableau de chaînes, une pour chaque URL de partie pré-signée
  • minPartSize : taille minimale à utiliser pour une partie = url
  • maxPartSize : taille maximale à utiliser pour une partie = url
{ "urls": [ "https://part1...", "https://part2..." ], "minPartSize": 10000, "maxPartSize": 100000 }
userData
object
Espace réservé facultatif contrôlé par le client et transmis tel quel aux événements de rendu. Permet aux clients d’ajouter des informations personnalisées pour identifier les événements de rendu. Ne doit pas être modifié ni utilisé dans les applications personnalisées, car les clients sont libres de modifier à tout moment ce paramètre.
{ ... }

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.

Nom
Type
Description
Exemple
*
*
Il est possible d’ajouter des champs personnalisés avancés qu’une application personnalisée peut comprendre.
embedBinaryLimit
number en octets
Si cette valeur est définie et que la taille de fichier du rendu est inférieure à cette valeur, le rendu est incorporé dans l’événement envoyé une fois la génération terminée. La taille maximale autorisée pour l’incorporation est de 32 Ko (32 x 1 024 octets). Si un rendu a une taille supérieure à la limite embedBinaryLimit, il est enregistré dans un espace de stockage dans le cloud et n’est pas incorporé à l’événement.
3276
width
number
Largeur en pixels. uniquement pour les rendus d’image.
200
height
number
Hauteur en pixels. uniquement pour les rendus d’image.
200

Les proportions sont toujours conservées si :

  • Les valeurs width et height sont spécifiées. L’image est alors adaptée à la taille tout en conservant les proportions
  • Seule la valeur width ou height est spécifiée. L’image obtenue utilise la dimension correspondante tout en conservant les proportions
  • Si aucune valeur width ou height n’est spécifiée, c’est la taille d’image d’origine en pixels qui est utilisée. Cela dépend du type de source. Pour certains formats, comme les fichiers PDF, une taille par défaut est utilisée. Il peut y avoir une limite de taille maximale.
quality
number
Spécifier la qualité jpeg dans une plage comprise entre 1 et 100. Applicable uniquement aux rendus d’image.
90
xmp
string
Utilisé uniquement par l’écriture différée des métadonnées XMP, il applique le format XMP avec codage base64 pour écrire dans le rendu spécifié.
interlace
bool
Créer un fichier PNG entrelacé, GIF ou JPEG progressif en fixant sa valeur à true. N’a aucun effet sur les autres formats de fichiers.
jpegSize
number
Taille approximative du fichier JPEG en octets. Il remplace tout paramètre quality. N’a aucun effet sur les autres formats.
dpi
number ou object
Définir la résolution en ppp pour x et y. Pour plus de simplicité, il est également possible de définir un nombre unique appliqué à la fois à x et y. Ce paramétrage n’a aucun effet sur l’image elle-même.
96 ou { xdpi: 96, ydpi: 96 }
convertToDpi
number ou object
Les résolutions en ppp pour x et y rééchantillonnent les valeurs tout en conservant la taille physique. Pour plus de simplicité, il est également possible de définir un nombre unique appliqué à la fois à x et y.
96 ou { xdpi: 96, ydpi: 96 }
files
array

Liste des fichiers à inclure dans l’archive ZIP (fmt=zip). Chaque entrée peut être soit une chaîne URL, soit un objet avec les champs :

  • url : URL de téléchargement du fichier
  • path : stockage du fichier selon ce chemin d’accès dans le fichier ZIP
[{ "url": "https://host/asset.jpg", "path": "folder/location/asset.jpg" }]
duplicate
string
Gestion des doublons pour les archives ZIP (fmt=zip). Par défaut, une erreur est générée si plusieurs fichiers de l’archive ZIP sont stockés sous le même chemin d’accès. Si vous définissez la valeur de duplicate sur ignore, seule la première ressource sera stockée et le reste sera ignoré.
ignore
watermark
object
Contient des instructions à propos du filigrane.

Champs spécifiques aux filigranes watermark-specific-fields

Le format PNG est utilisé comme filigrane.

Nom
Type
Description
Exemple
scale
number
Échelle du filigrane, entre 0.0 et 1.0. 1.0 signifie que le filigrane est à son échelle d’origine (1:1) et que les valeurs inférieures réduisent sa taille.
Une valeur de 0.5 correspond à la moitié de la taille d’origine.
image
url
URL d’accès au fichier PNG à utiliser 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 Adobe I/O journal des événements. Les 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 la charge utile réelle de l’événement.

Le type Événement Adobe I/O pour tous les événements de l’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 I/O. 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

Événement
Description
rendition_created
Envoyé pour chaque rendu traité et chargé.
rendition_failed
Envoyé pour chaque rendu dont le traitement ou le chargement a échoué.

Attributs d’événement event-attributes

Attribut
Type
Événement
Description
date
string
*
Horodatage du moment où l’événement a été envoyé au format étendu simplifié ISO-8601, tel que défini par JavaScript Date.toISOString().
requestId
string
*
Identifiant de la requête d’origine à /process, identique à l’en-tête X-Request-Id.
source
object
*
source de la requête /process.
userData
object
*
L’objet userData du rendu issu de la requête /process, si une définition existe.
rendition
object
rendition_*
Objet de rendu correspondant transmis dans /process.
metadata
object
rendition_created
Les propriétés des métadonnées du rendu.
errorReason
string
rendition_failed
La raison de l’échec du rendu, le cas échéant.
errorMessage
string
rendition_failed
Texte donnant, le cas échéant, davantage de détails sur l’échec du rendu.

Métadonnées metadata

Propriété
Description
repo:size
Taille du rendu en octets.
repo:sha1
Résumé sha1 du rendu.
dc:format
Type MIME du rendu.
repo:encoding
Codage du jeu de caractères du rendu dans le cas où il s’agit d’un format texte.
tiff:ImageWidth
Largeur du rendu en pixels. Uniquement présente pour les rendus d’image.
tiff:ImageLength
Longueur du rendu en pixels. Uniquement présente pour les rendus d’image.

Raisons de l’erreur error-reasons

Raison
Description
RenditionFormatUnsupported
Le format de rendu demandé n’est pas pris en charge pour la source donnée.
SourceUnsupported
La source spécifique n’est pas prise en charge même si le type est pris en charge.
SourceCorrupt
Les données source sont endommagées. Inclut des fichiers vides.
RenditionTooLarge
Impossible de charger le rendu à l’aide des URL présignées indiquées dans target. La taille réelle du rendu est disponible sous forme de métadonnées dans repo:size et peut être utilisée par le client pour traiter à nouveau ce rendu avec le nombre approprié d’URL présignées.
GenericError
Toute autre erreur inattendue.
recommendation-more-help
b027be24-3772-44c0-a56d-a4ba23dcb50b