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

API:t används endast i utvecklingssyfte. API:t anges som ett sammanhang när du utvecklar anpassade program. Adobe Experience Manager som Cloud Service använder API:t för att skicka bearbetningsinformationen till ett anpassat program. Mer information finns i Använda resursmikrotjänster och Bearbeta profiler.

Alla klienter för HTTP-API:t Asset Compute Service måste följa detta högnivåflöde:

Modulen adobe-asset-compute-client gör det enkelt att använda API:t i Node.js-koden.

Autentisering och auktorisering authentication-and-authorization

Alla API:er kräver åtkomsttokenautentisering. Förfrågningarna måste ange följande rubriker:

Omfång scopes

Kontrollera följande scope för åtkomsttoken:

Dessa omfattningar kräver att projektet Adobe Developer Console prenumererar på tjänsterna Asset Compute, I/O Events och I/O Management API. Uppdelningen av enskilda omfattningar är:

Registrering register

Varje klient för Asset Compute service - ett unikt Adobe Developer Console-projekt som prenumererar på tjänsten - måste registrera innan bearbetningen kan göras. Registreringssteget returnerar den unika händelsjournal som krävs för att hämta asynkrona händelser från återgivningsbearbetningen.

När livscykeln är slut kan en klient avregistrera.

Registrera förfrågan register-request

Detta API-anrop konfigurerar en Asset Compute-klient och tillhandahåller händelsens journal-URL. Den här processen är en depotent åtgärd och behöver bara anropas en gång för varje klient. Den kan anropas igen för att hämta journal-URL:en.

Registrera svar register-response

HTTP-statuskoderna är:

Avregistrera förfrågan unregister-request

Detta API-anrop avregistrerar en Asset Compute-klient. När avregistreringen är klar går det inte längre att anropa /process. Om API-anropet för en oregistrerad klient eller en ännu inte registrerad klient används returneras felet 404.

Avregistrera svar unregister-response

Statuskoderna är:

Bearbeta begäran process-request

Åtgärden process skickar ett jobb som omvandlar en källresurs till flera återgivningar, baserat på instruktionerna i begäran. Meddelanden om slutförande (händelsetyp rendition_created) eller eventuella fel (händelsetyp rendition_failed) skickas till en händelseljournal som måste hämtas med /register en gång innan du kan göra ett antal /process-begäranden. Felaktigt utformade begäranden misslyckas omedelbart med 400-felkod.

Binärfiler refereras med URL:er, som försignerade URL:er för Amazon AWS S3 eller Azure Blob Storage SAS-URL:er. Används för att både läsa source-resursen (GET URL:er) och skriva återgivningarna (PUT URL:er). Klienten ansvarar för att generera dessa försignerade URL:er.

Bearbeta begäran JSON process-request-json

Begärandetexten för /process är ett JSON-objekt med detta högnivåschema:

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

De tillgängliga fälten är:

source kan antingen vara en <string> som ses som en URL eller en <object> med ett extra fält. Följande varianter är lika:

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

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

Source objektfält source-object-fields

Ett fullständigt exempel på process-begäran 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"
    }]
}

Processsvar process-response

/process-begäran returneras omedelbart med ett lyckat eller misslyckat svar baserat på den grundläggande begärandevalideringen. Faktisk bearbetning av resurser sker asynkront.

Statuskoder:

De flesta klienter vill antagligen försöka utföra samma begäran igen med exponentiell säkerhetskopiering vid ett fel förutom konfigurationsproblem som 401 eller 403, eller ogiltiga begäranden som 400. Förutom en vanlig hastighetsbegränsning med 429 svar kan ett tillfälligt avbrott eller en tillfällig begränsning leda till 5 x fel. Det vore då tillrådligt att försöka igen efter en viss tid.

Alla JSON-svar (om sådana finns) innehåller requestId, som är samma värde som huvudet X-Request-Id. Adobe rekommenderar att du läser från sidhuvudet eftersom det alltid finns. requestId returneras också i alla händelser som rör bearbetning av begäranden som requestId. Klienterna får inte anta något om formatet för den här strängen. Det är en ogenomskinlig strängidentifierare.

Anmäl dig till efterbearbetning opt-in-to-post-processing

Asset Compute SDK har stöd för en uppsättning grundläggande alternativ för efterbearbetning av bilder. Anpassade arbetare kan uttryckligen välja att efterbearbeta genom att ange fältet postProcess för återgivningsobjektet till true.

De användningsområden som stöds är:

Vattenstämpelresurser add-watermark

Asset Compute SDK har stöd för att lägga till en vattenstämpel i bildfilerna PNG, JPEG, TIFF och GIF. Vattenstämpeln läggs till efter återgivningsinstruktionerna i objektet watermark på återgivningen.

Vattenstämplar görs under efterbearbetningen av återgivningen. För vattenstämpelresurser väljer den anpassade arbetaren efterbearbetning genom att ange fältet postProcess för återgivningsobjektet till true. Om arbetaren inte väljer att delta används inte vattenstämplar, även om vattenstämpelobjektet har angetts för återgivningsobjektet i begäran.

Återgivningsinstruktioner rendition-instructions

Följande är tillgängliga alternativ för arrayen renditions i /process.

Vanliga fält common-fields

Återgivningsspecifika fält rendition-specific-fields

En lista över de filformat som stöds finns i Filformat som stöds.

Vattenstämpelsspecifika fält watermark-specific-fields

PNG-formatet används som vattenstämpel.

Asynkrona händelser asynchronous-events

När bearbetningen av en återgivning är klar eller när ett fel inträffar, skickas en händelse till Adobe I/O Events Journal. Klienterna måste lyssna på den journal-URL som tillhandahålls via /register. Journalsvaret innehåller en event-matris som består av ett objekt för varje händelse, varav fältet event innehåller den faktiska händelsens nyttolast.

Adobe I/O Events-typen för alla händelser i Asset Compute Service är asset_compute. Journalen prenumererar automatiskt på endast den här händelsetypen och det finns inget ytterligare krav på att filtrera baserat på händelsetypen Adobe Developer. Tjänstspecifika händelsetyper är tillgängliga i egenskapen type för händelsen.

Händelsetyper event-types

Händelseattribut event-attributes

Metadata metadata

Felorsaker error-reasons