API HTTP Asset Compute Service 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, vedere Utilizzare i microservizi delle risorse e i profili di elaborazione.

Qualsiasi client dell'API HTTP Asset Compute Service deve seguire questo flusso di alto livello:

Il modulo adobe-asset-compute-client semplifica l'utilizzo dell'API nel codice 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 ambiti richiedono la sottoscrizione del progetto Adobe Developer Console ai servizi Asset Compute, I/O Events e I/O Management API. La ripartizione dei singoli ambiti è la seguente:

Registrazione register

Ogni client di Asset Compute service - un progetto Adobe Developer Console univoco sottoscritto al servizio - deve registrarsi 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 ciclo di vita, un client può annullare la registrazione.

Registra richiesta register-request

Questa chiamata API configura un client Asset Compute e fornisce l'URL del giornale di registrazione eventi. Questo processo è un’operazione idempotente e deve essere chiamato 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 client Asset Compute. Dopo l'annullamento della registrazione 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 errore 404.

Annulla registrazione risposta unregister-response

I codici di stato sono:

Richiesta di elaborazione process-request

L'operazione process invia un processo che trasforma una risorsa di origine in più rappresentazioni, in base alle istruzioni contenute nella richiesta. Le notifiche di completamento (tipo evento rendition_created) o di errori (tipo evento rendition_failed) vengono inviate a un giornale di registrazione eventi che deve essere recuperato una volta con /register prima di effettuare un numero qualsiasi di richieste /process. 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 archiviazione Azure Blob. Utilizzato sia per leggere la risorsa source (GET URL) che per scrivere le 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:

source può essere un <string> visualizzato come URL oppure 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 Source source-object-fields

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

La richiesta /process 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 ritentare la stessa richiesta con backoff esponenziale per qualsiasi errore eccetto problemi di configurazione come 401 o 403 o richieste non valide come 400. A parte la regolare limitazione delle tariffe tramite 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 dell'intestazione X-Request-Id. L’Adobe consiglia di leggere dall’intestazione perché è sempre presente. 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

Asset Compute SDK supporta un set di opzioni di post-elaborazione di base per le immagini. I processi di lavoro personalizzati possono acconsentire in modo esplicito alla post-elaborazione impostando il campo postProcess sull'oggetto rendering su true.

I casi d’uso supportati sono:

Risorse filigrana add-watermark

Asset Compute SDK supporta l'aggiunta di una filigrana ai file immagine PNG, JPEG, TIFF e GIF. La filigrana viene aggiunta seguendo le istruzioni per il rendering nell'oggetto watermark del rendering.

La filigrana viene eseguita durante la post-elaborazione della rappresentazione. Per applicare una filigrana alle risorse, il processo di lavoro personalizzato opta per la post-elaborazione impostando il campo postProcess dell'oggetto di rendering su true. Se il lavoratore 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

Di seguito sono riportate le opzioni disponibili per l'array renditions in /process.

Campi comuni common-fields

Campi specifici della rappresentazione rendition-specific-fields

Per un elenco dei formati di file attualmente supportati, vedere 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 copia trasformata o quando si verifica un errore, un evento viene inviato a un Adobe I/O Events Journal. I client devono ascoltare l'URL del diario fornito tramite /register. La risposta del journal include un array event costituito da un oggetto per ogni evento, di cui il campo event include il payload dell'evento effettivo.

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

Tipi di evento event-types

Attributi evento event-attributes

Metadati metadata

Motivi di errore error-reasons