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. Zie voor meer informatie Middelenmicroservices en verwerkingsprofielen gebruiken.

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

De @adobe/asset-compute-client 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:

Hiervoor zijn Adobe Developer Console project waarop moet worden geabonneerd Asset Compute, I/O Events, en I/O Management API diensten. De uitsplitsing van individuele scènes is:

Registratie register

Elke client van de Asset Compute service - een unieke Adobe Developer Console project geabonneerd op de dienst - most registreren voordat u verzoeken om verwerking indient. De registratiestap retourneert het unieke gebeurtenisjournaal dat vereist is om de asynchrone gebeurtenissen van de uitvoering op te halen.

Aan het einde van de levenscyclus kan een client unregister.

Aanvraag registreren register-request

Deze API-aanroep stelt een Asset Compute en geeft de URL van het gebeurtenisjournaal weer. Dit is een epidemische bewerking die slechts één keer voor elke client hoeft te worden uitgevoerd. 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 Asset Compute client. Hierna is het niet meer mogelijk /process. Wanneer de API-aanroep voor een niet-geregistreerde client wordt gebruikt of een nog te registreren client een 404 fout.

Reactie ongedaan maken unregister-response

De statuscodes zijn:

Procesaanvraag process-request

De process bewerking verzendt een taak die een bronelement in meerdere uitvoeringen omzet, op basis van de instructies in de aanvraag. Meldingen over geslaagde voltooiing (gebeurtenistype) rendition_created) of fouten (gebeurtenistype) rendition_failed) worden verzonden naar een gebeurtenisjournaal dat moet worden opgehaald met /register om het even welk aantal /process verzoeken. Onjuist gevormde verzoeken ontbreken onmiddellijk met een 400 foutencode.

Er wordt verwezen naar binaire URL's, zoals vooraf ondertekende URL's van Amazon AWS S3 of Azure Blob Storage SAS URL's, voor beide leesbewerkingen van de source activa (GET URL's) en de vertoningen schrijven (PUT URL's). De klant is verantwoordelijk voor het genereren van deze vooraf ondertekende URL's.

Verzoek om verwerking JSON process-request-json

De verzoekende instantie /process is een JSON-object met dit schema op hoog niveau:

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

De beschikbare velden zijn:

De source kan <string> die als een URL wordt beschouwd 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"
}

Bronobjectvelden source-object-fields

Een complete process aanvraagvoorbeeld 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 het verzoek keert onmiddellijk met een succes of een mislukking terug die op de basisverzoekbevestiging wordt gebaseerd. De werkelijke verwerking van elementen gebeurt asynchroon.

Statuscodes:

De meeste klanten zijn waarschijnlijk geneigd om exact hetzelfde verzoek opnieuw uit te voeren met exponentiële backoff bij elke fout behalve configuratieproblemen zoals 401 of 403 of ongeldige verzoeken zoals 400. Afgezien van een reguliere tariefbeperking via 429 reacties, kan een tijdelijke onderbreking of beperking van de service leiden tot 5x fouten. Het zou dan raadzaam zijn om na een bepaalde periode opnieuw te proberen.

Alle JSON-reacties (indien aanwezig) bevatten de requestId dat dezelfde waarde heeft als de X-Request-Id header. Het wordt aanbevolen om van de koptekst te lezen, aangezien deze altijd aanwezig is. De requestId wordt ook geretourneerd in alle gebeurtenissen met betrekking tot verwerkingsverzoeken als requestId. Clients mogen geen aanname maken over de opmaak van deze tekenreeks, het is een ondoorzichtige tekenreeks-id.

Inschakelen naar naverwerking opt-in-to-post-processing

De asset compute SDK ondersteunt een aantal basisopties voor nabewerking van afbeeldingen. Aangepaste workers kunnen zich expliciet aanmelden bij naverwerking door het veld in te stellen postProcess op het weergaveobject naar true.

De ondersteunde gebruiksgevallen zijn:

Watermerkelementen add-watermark

De asset compute SDK ondersteunt het toevoegen van een watermerk aan PNG-, JPEG-, TIFF- en GIF-afbeeldingsbestanden. Het watermerk wordt toegevoegd na de vertoningsinstructies in het dialoogvenster watermark object op de vertoning.

Watermerken worden uitgevoerd tijdens de nabewerking van de vertoning. De aangepaste worker voor watermerkelementen na verwerking door het veld in te stellen postProcess op het weergaveobject naar true. Als de worker niet de optie Weigeren inschakelt, wordt het watermerk niet toegepast, zelfs niet als het watermerkobject is ingesteld op het weergaveobject in de aanvraag.

Vertoningsinstructies rendition-instructions

Dit zijn de beschikbare opties voor de renditions array in /process.

Algemene velden common-fields

Vertoningsspecifieke velden rendition-specific-fields

Voor een lijst met momenteel ondersteunde bestandsindelingen raadpleegt u ondersteunde bestandsindelingen.

Watermerkspecifieke velden watermark-specific-fields

De PNG-indeling wordt gebruikt als een watermerk.

Asynchrone gebeurtenissen asynchronous-events

Nadat een vertoning is verwerkt of een fout optreedt, wordt een gebeurtenis verzonden naar een Adobe I/O Events Journal. Clients moeten luisteren naar de journaal-URL die via /register. De dagboekreactie omvat een event array die bestaat uit één object voor elke gebeurtenis, waarvan de event bevat het daadwerkelijke gebeurtenislaadveld.

De Adobe I/O Gebeurtenistype voor alle gebeurtenissen van het dialoogvenster Asset Compute Service is asset_compute. Het dagboek wordt automatisch ingetekend op dit gebeurtenistype slechts en er is geen verdere vereiste om te filtreren die op Adobe I/O Type gebeurtenis. De de dienstspecifieke gebeurtenistypes zijn beschikbaar in type eigenschap van de gebeurtenis.

Gebeurtenistypen event-types

Gebeurteniskenmerken event-attributes

Metagegevens metadata

Foutredenen error-reasons