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

L’utilizzo dell’API è limitato a scopi di sviluppo. L’API viene fornita come contesto durante lo sviluppo di applicazioni personalizzate. Adobe Experience Manager as a Cloud Service utilizza l’API per passare le informazioni di elaborazione a un’applicazione personalizzata. Per ulteriori informazioni, consulta Utilizzare i microservizi delle risorse e i profili di elaborazione.

Qualsiasi client del Asset Compute Service L’API HTTP deve seguire questo flusso di alto livello:

Il @adobe/asset-compute-client Questo modulo semplifica l’utilizzo dell’API nel codice di Node.js.

Autenticazione e autorizzazione authentication-and-authorization

Tutte le API richiedono l’autenticazione tramite token di accesso. Le richieste devono impostare le seguenti intestazioni:

Ambiti scopes

Verifica che il token di accesso sia conforme ai seguenti ambiti:

Questi richiedono Adobe Developer Console progetto a cui iscriversi Asset Compute, I/O Events, e I/O Management API servizi. La ripartizione dei singoli ambiti è la seguente:

Registrazione register

Ogni client del Asset Compute service - una Adobe Developer Console progetto abbonato al servizio - obbligatorio registrare prima di elaborare le richieste. Il passaggio di registrazione restituisce il giornale di registrazione eventi univoco necessario per recuperare gli eventi asincroni dall’elaborazione della rappresentazione.

Al termine del suo ciclo di vita, un client può annulla registrazione.

Registra richiesta register-request

Questa chiamata API configura una Asset Compute e fornisce l'URL del giornale di registrazione eventi. Si tratta di un’operazione idempotente e deve essere chiamata solo una volta per ogni client. Può essere richiamato nuovamente per recuperare l’URL del diario.

Registra risposta register-response

I codici di stato HTTP sono:

Annulla registrazione richiesta unregister-request

Questa chiamata API annulla la registrazione di un Asset Compute client. In seguito non sarà più possibile chiamare /process. L’utilizzo della chiamata API per un client non registrato o per un client non ancora registrato restituisce un 404 errore.

Annulla registrazione risposta unregister-response

I codici di stato sono:

Richiesta di elaborazione process-request

Il process L'operazione sottomette un processo che trasforma una risorsa di origine in più rappresentazioni, in base alle istruzioni contenute nella richiesta. Notifiche di completamento (tipo di evento) rendition_created) o eventuali errori (tipo di evento rendition_failed) vengono inviate a un giornale di registrazione eventi che deve essere recuperato utilizzando /register una volta prima di effettuare un numero qualsiasi di /process richieste. Le richieste formate in modo errato hanno immediatamente esito negativo con un codice di errore 400.

I riferimenti binari vengono eseguiti utilizzando URL, ad esempio URL prefirmati di Amazon AWS S3 o URL SAS di Azure Blob Storage, per entrambe le operazioni di lettura di source risorsa (GET URL e scrittura delle rappresentazioni (PUT URL). Il client è responsabile della generazione di questi URL prefirmati.

Elabora JSON richiesta process-request-json

Il corpo della richiesta di /process è un oggetto JSON con questo schema di alto livello:

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

I campi disponibili sono:

Il source può essere un <string> che viene visualizzato come URL o può essere un <object> con un campo aggiuntivo. Le seguenti varianti sono simili:

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

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

Campi oggetto di origine source-object-fields

Un completo process esempio di richiesta 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"
    }]
}

Risposta processo process-response

Il /process La richiesta restituisce immediatamente un risultato positivo o negativo in base alla convalida della richiesta di base. L’elaborazione effettiva delle risorse avviene in modo asincrono.

Codici di stato:

La maggior parte dei client è probabilmente incline a riprovare la stessa richiesta con backoff esponenziale in caso di errori eccetto problemi di configurazione come 401 o 403, oppure richieste non valide come 400. A parte la limitazione regolare della frequenza tramite le risposte 429, un’interruzione temporanea del servizio o una limitazione potrebbero causare errori 5xx. Sarebbe quindi consigliabile riprovare dopo un certo periodo di tempo.

Tutte le risposte JSON (se presenti) includono requestId che è lo stesso valore del X-Request-Id intestazione. Si consiglia di leggere dall’intestazione, poiché è sempre presente. Il requestId viene restituito anche in tutti gli eventi relativi all’elaborazione delle richieste come requestId. I client non devono fare alcuna supposizione sul formato di questa stringa, è un identificatore di stringa opaco.

Consenso alla post-elaborazione opt-in-to-post-processing

Il SDK ASSET COMPUTE supporta una serie di opzioni di base per la post-elaborazione delle immagini. I lavoratori personalizzati possono acconsentire esplicitamente alla post-elaborazione impostando il campo postProcess sull'oggetto rendering a true.

I casi d’uso supportati sono:

Risorse filigrana add-watermark

Il SDK ASSET COMPUTE supporta l’aggiunta di una filigrana ai file immagine PNG, JPEG, TIFF e GIF. La filigrana viene aggiunta seguendo le istruzioni per la rappresentazione contenute nella sezione watermark nella rappresentazione.

La filigrana viene eseguita durante la post-elaborazione della rappresentazione. Per applicare una filigrana alle risorse, il lavoratore personalizzato opta per la post-elaborazione impostando il campo postProcess sull'oggetto rendering a true. Se il processo di lavoro non acconsente, la filigrana non viene applicata, anche se l'oggetto filigrana è impostato sull'oggetto di rendering nella richiesta.

Istruzioni per la rappresentazione rendition-instructions

Queste sono le opzioni disponibili per renditions array in /process.

Campi comuni common-fields

Campi specifici della rappresentazione rendition-specific-fields

Per un elenco dei formati di file attualmente supportati, consulta formati di file supportati.

Campi specifici della filigrana watermark-specific-fields

Il formato PNG viene utilizzato come filigrana.

Eventi asincroni asynchronous-events

Al termine dell’elaborazione di una rappresentazione o quando si verifica un errore, un evento viene inviato a un Adobe I/O Giornale di registrazione eventi. I client devono ascoltare l'URL del diario fornito tramite /register. La risposta del giornale di registrazione include event array costituito da un oggetto per ogni evento, di cui event include il payload dell’evento effettivo.

Il Adobe I/O Tipo di evento per tutti gli eventi del Asset Compute Service è asset_compute. Il giornale di registrazione viene automaticamente iscritto solo a questo tipo di evento e non è necessario filtrare ulteriormente in base al Adobe I/O Tipo di evento. I tipi di evento specifici del servizio sono disponibili nel type proprietà dell’evento.

Tipi di evento event-types

Attributi evento event-attributes

Metadati metadata

Motivi di errore error-reasons