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

Het gebruik van de API is beperkt tot ontwikkelingsdoeleinden. De API wordt als context verstrekt wanneer het ontwikkelen van douanetoepassingen. Adobe Experience Manager als Cloud Service gebruikt de API om de verwerkingsgegevens door te geven aan een aangepaste toepassing. Voor meer informatie, zie de activamicrodiensten van het Gebruik en Profielen van de Verwerking.

Elke client van de Asset Compute Service HTTP API moet deze flow op hoog niveau volgen:

De adobe-asset-compute-cliëntmodule maakt het gemakkelijk om API in code Node.js te gebruiken.

Verificatie en autorisatie authentication-and-authorization

Voor alle API's is verificatie van toegangstoken vereist. De verzoeken moeten de volgende kopballen plaatsen:

Segmenten scopes

Verzeker het volgende werkingsgebied voor het toegangstoken:

Voor deze bereiken moet het Adobe Developer Console -project zijn geabonneerd op Asset Compute , I/O Events en I/O Management API -services. De uitsplitsing van individuele scènes is:

Registratie register

Elke cliënt van Asset Compute service - een uniek Adobe Developer Console project dat aan de dienst wordt ingetekend - moet registrerenalvorens verwerkingsverzoeken te maken. De registratiestap retourneert het unieke gebeurtenisjournaal dat vereist is om de asynchrone gebeurtenissen van de uitvoering op te halen.

Aan het eind van zijn levenscyclus, kan een cliënt 🔗 unregister.

Aanvraag registreren register-request

Met deze API-aanroep wordt een Asset Compute -client ingesteld en wordt de URL van het gebeurtenisdagboek weergegeven. Dit proces is een epidemische bewerking en hoeft slechts één keer voor elke client te worden aangeroepen. Het kan opnieuw worden geroepen om het dagboek URL terug te winnen.

Reactie registreren register-response

De HTTP-statuscodes zijn:

Aanvraag ongedaan maken unregister-request

Met deze API-aanroep wordt de registratie van een Asset Compute -client ongedaan gemaakt. Nadat de registratie ongedaan is gemaakt, kan /process niet meer worden aangeroepen. Als u de API-aanroep voor een niet-geregistreerde client of een nog te registreren client gebruikt, wordt een 404 -fout geretourneerd.

Reactie ongedaan maken unregister-response

De statuscodes zijn:

Procesaanvraag process-request

De bewerking process verzendt een taak die een bronelement transformeert in meerdere uitvoeringen, op basis van de instructies in de aanvraag. Meldingen over een geslaagde voltooiing (gebeurtenistype rendition_created ) of over eventuele fouten (gebeurtenistype rendition_failed ) worden verzonden naar een gebeurtenisvenster dat één keer met /register moet worden opgehaald voordat een aantal /process -aanvragen kan worden ingediend. Onjuist gevormde verzoeken ontbreken onmiddellijk met een 400 foutencode.

Er wordt verwezen naar binaire getallen via URL's, zoals vooraf ondertekende URL's voor Amazon AWS S3 of Azure Blob Storage SAS-URL's. Wordt gebruikt voor het lezen van het element source (GET URLs) en het schrijven van de vertoningen (PUT URLs). De klant is verantwoordelijk voor het genereren van deze vooraf ondertekende URL's.

Verzoek om verwerking JSON process-request-json

De aanvraaghoofdtekst van /process is een JSON-object met dit schema op hoog niveau:

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

De beschikbare velden zijn:

De source kan een <string> zijn die als een URL wordt gezien of een <object> met een extra veld. De volgende varianten zijn vergelijkbaar:

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

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

Source-objectvelden source-object-fields

Een volledig aanvraagvoorbeeld 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"
    }]
}

Procesreactie process-response

De /process -aanvraag wordt onmiddellijk geretourneerd met succes of als de aanvraag is mislukt op basis van de validatie van de basisaanvraag. De werkelijke verwerking van elementen gebeurt asynchroon.

Statuscodes:

De meeste cliënten zijn waarschijnlijk geneigd om het zelfde verzoek met exponentiële backoffop om het even welke fout behalve configuratiekwesties zoals 401 of 403, of ongeldige verzoeken zoals 400 opnieuw te proberen. Afgezien van de reguliere tariefbeperking door middel van 429 reacties, kan een uitval of beperking van een tijdelijke dienst leiden tot 5xx fouten. Het zou dan raadzaam zijn om na een bepaalde periode opnieuw te proberen.

Alle JSON-reacties (indien aanwezig) bevatten requestId . Dit is dezelfde waarde als de X-Request-Id -header. Adobe raadt aan de koptekst te lezen omdat deze altijd aanwezig is. requestId wordt ook geretourneerd in alle gebeurtenissen die betrekking hebben op het verwerken van aanvragen als requestId . Clients mogen geen aanname maken over de opmaak van deze tekenreeks. Dit is een ondoorzichtige tekenreeks-id.

Aanmelden bij nabewerking opt-in-to-post-processing

De SDK van Asset Computesteunt een reeks basisbeeld naverwerkingsopties. Aangepaste workers kunnen zich expliciet aanmelden bij nabewerking door het veld postProcess voor het weergaveobject in te stellen op true .

De ondersteunde gebruiksgevallen zijn:

Watermerkelementen add-watermark

De SDK van Asset Computesteunt het toevoegen van een watermerk aan PNG, JPEG, TIFF, en de beelddossiers van GIF. Het watermerk wordt toegevoegd na de vertoningsinstructies in het watermark -object op de vertoning.

Watermerken worden uitgevoerd tijdens de nabewerking van de vertoning. Om activa van het watermerk te voorzien, opteert de douanearbeider in post-verwerkingdoor het gebied postProcess op het vertoningsvoorwerp aan true te plaatsen. Als de worker niet meedoet, wordt er geen watermerken toegepast, zelfs niet als het watermerkobject is ingesteld op het weergaveobject in de aanvraag.

Vertoningsinstructies rendition-instructions

Hieronder vindt u de beschikbare opties voor de array renditions in /process .

Algemene velden common-fields

Vertoningsspecifieke velden rendition-specific-fields

Voor een lijst van momenteel gesteunde dossierformaten, zie gesteunde dossierformaten.

Watermerkspecifieke velden watermark-specific-fields

De PNG-indeling wordt gebruikt als een watermerk.

Asynchrone gebeurtenissen asynchronous-events

Wanneer de verwerking van een vertoning is voltooid of wanneer een fout optreedt, wordt een gebeurtenis verzonden naar een Adobe I/O Events Journal . Clients moeten luisteren naar de journaal-URL die via /register wordt geboden. De journaalreactie bevat een array event die bestaat uit één object voor elke gebeurtenis, waarvan het veld event de werkelijke gebeurtenislading bevat.

Het Adobe I/O Events -type voor alle gebeurtenissen van de lus Asset Compute Service is asset_compute . Het tijdschrift wordt alleen automatisch op dit gebeurtenistype geabonneerd en er is geen verdere vereiste om te filteren op basis van het gebeurtenistype Adobe Developer . De service-specifieke gebeurtenistypen zijn beschikbaar in de eigenschap type van de gebeurtenis.

Gebeurtenistypen event-types

Gebeurteniskenmerken event-attributes

Metagegevens metadata

Foutredenen error-reasons