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

Die Verwendung der API ist auf Entwicklungszwecke beschränkt. Die API wird bei der Entwicklung benutzerdefinierter Programme als Kontext bereitgestellt. Adobe Experience Manager as a Cloud Service verwendet die API, um die Verarbeitungsinformationen an ein benutzerdefiniertes Programm zu übergeben. Weitere Informationen finden Sie unter Verwenden von Asset-Microservices und Verarbeitungsprofilen.

Jeder Client der Asset Compute Service-HTTP-API muss diesem allgemeinen Ablauf folgen:

Das Modul adobe/asset-compute-client vereinfacht die Verwendung der API im Node.js-Code.

Authentifizierung und Autorisierung authentication-and-authorization

Für alle APIs ist eine Zugriffs-Token-Authentifizierung erforderlich. Die Anfragen müssen die folgenden Kopfzeilen festlegen:

Bereiche scopes

Stellen Sie die folgenden Bereiche für das Zugriffs-Token sicher:

Für diese Bereiche muss das Adobe Developer Console-Projekt die Services Asset Compute, I/O Events, und I/O Management API abonnieren. Die einzelnen Bereiche werden wie folgt unterteilt:

Registrierung register

Jeder Client von Asset Compute service – ein eindeutiges Adobe Developer Console-Projekt, das den Service abonniert hat – muss sich registrieren, bevor er Verarbeitungsanfragen stellen kann. Der Registrierungsschritt gibt das eindeutige Ereignisjournal zurück, das zum Abrufen der asynchronen Ereignisse aus der Verarbeitung der Ausgabedarstellung erforderlich ist.

Am Ende seines Lebenszyklus kann ein Client die Registrierung aufheben.

Registrierungsanfrage register-request

Mit diesem API-Aufruf wird ein Asset Compute-Client eingerichtet und die Ereignisjournal-URL bereitgestellt. Dies ist ein idempotenter Vorgang, der für jeden Client nur einmal aufgerufen werden muss. Er kann erneut aufgerufen werden, um die Journal-URL abzurufen.

Registrierungsantwort register-response

Die HTTP-Status-Codes lauten:

Anfrage zum Aufheben der Registrierung unregister-request

Durch diesen API-Aufruf wird die Registrierung eines Asset Compute-Clients aufgehoben. Danach kann /process nicht mehr aufgerufen werden. Wenn Sie den API-Aufruf für einen nicht registrierten Client oder einen noch nicht registrierten Client verwenden, wird ein 404-Fehler zurückgegeben.

Antwort zum Aufheben der Registrierung unregister-response

Die Status-Codes sind:

Verarbeitungsanfrage process-request

Der process-Vorgang sendet einen Auftrag, der ein Quell-Asset basierend auf den Anweisungen in der Anfrage in mehrere Ausgabedarstellungen umwandelt. Benachrichtigungen über einen erfolgreichen Abschluss (Ereignistyp rendition_created) oder einen Fehler (Ereignistyp rendition_failed) werden an ein Ereignisjournal gesendet, das einmal mit /register abgerufen werden muss, bevor eine beliebige Anzahl von /process-Anfragen gestellt werden kann. Fehlerhaft gebildete Anfragen schlagen sofort mit einem Fehler-Code 400 fehl.

Binärdateien werden mithilfe von URLs referenziert, z. B. mit von Amazon AWS S3 vorsignierten URLs oder Azure Blob Storage-SAS-URLs. Sie dienen sowohl zum Lesen des source-Assets (GET-URLs) als auch zum Schreiben der Ausgabedarstellungen (PUT-URLs). Der Client ist für die Generierung dieser vorsignierten URLs verantwortlich.

JSON der Verarbeitungsanfrage process-request-json

Der Hauptteil der /process-Anfrage ist ein JSON-Objekt mit diesem allgemeinen Schema:

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

Die folgenden Felder sind verfügbar:

source kann entweder ein <string> sein, der als URL erkannt wird, oder ein <object> mit einem zusätzlichen Feld. Die folgenden Varianten sind ähnlich:

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

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

Quellobjektfelder source-object-fields

Beispiel einer vollständigen process-Anfrage 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"
    }]
}

Verarbeitungsantwort process-response

Die /process-Anfrage wird sofort mit einem Erfolg oder Fehler basierend auf der grundlegenden Anfragenvalidierung zurückgegeben. Die tatsächliche Asset-Verarbeitung erfolgt asynchron.

Status-Codes:

Die meisten Clients neigen dazu, dieselbe Anfrage mit exponentiellem Backoff bei Fehlern zu wiederholen, mit Ausnahme von Konfigurationsproblemen wie 401 oder 403 oder ungültigen Anfragen wie 400. Abgesehen von der regulären Ratenbegrenzung über Antworten vom Typ 429 kann ein vorübergehender Service-Ausfall oder eine vorübergehende Service-Beschränkung zu 5xx-Fehlern führen. Es wäre in dem Fall ratsam, es nach einer gewissen Zeit erneut zu versuchen.

Alle JSON-Antworten (sofern vorhanden) enthalten die requestId, die dem Wert des X-Request-Id-Headers entspricht. Adobe empfiehlt, Informationen aus dem Header zu lesen, da dieser immer vorhanden ist. Die requestId wird auch in allen Ereignissen, die mit Verarbeitungsanfragen zusammenhängen, als requestId zurückgegeben. Clients dürfen keine Annahmen über das Format dieser Zeichenfolge treffen. Es handelt sich um eine opake Zeichenfolgenkennung.

Opt-in für die Nachbearbeitung opt-in-to-post-processing

Das Asset Compute SDK unterstützt eine Reihe grundlegender Optionen für die Nachbearbeitung von Bildern. Benutzerdefinierte Sekundärprogramme können sich explizit für die Nachbearbeitung entscheiden, indem sie das Feld postProcess im Ausgabedarstellungsobjekt auf true setzen.

Folgende Anwendungsfälle werden unterstützt:

Wasserzeichen-Assets add-watermark

Das Asset Compute SDK unterstützt das Hinzufügen eines Wasserzeichens zu PNG-, JPEG-, TIFF- und GIF-Bilddateien. Das Wasserzeichen wird der Ausgabedarstellung entsprechend den Ausgabedarstellungsanweisungen im watermark-Objekt hinzugefügt.

Das Wasserzeichen wird während der Nachbearbeitung der Ausgabedarstellung hinzugefügt. Um Assets mit Wasserzeichen zu versehen, aktiviert das benutzerdefinierte Sekundärprogramm die Nachbearbeitung, indem es das Feld postProcess im Ausgabedarstellungsobjekt auf true setzt. Wenn sich das Sekundärprogramm nicht dafür entscheidet, wird das Wasserzeichen nicht hinzugefügt, auch wenn das Wasserzeichenobjekt im Ausgabedarstellungsobjekt in der Anfrage gesetzt ist.

Ausgabedarstellungsanweisungen rendition-instructions

Im Folgenden sind die verfügbaren Optionen für das Array renditions in /process aufgeführt.

Allgemeine Felder common-fields

Ausgabedarstellungsspezifische Felder rendition-specific-fields

Eine Liste der derzeit unterstützten Dateiformate finden Sie unter Unterstützte Dateiformate.

Wasserzeichenspezifische Felder watermark-specific-fields

Das PNG-Format wird für Wasserzeichen verwendet.

Asynchrone Ereignisse asynchronous-events

Sobald die Verarbeitung einer Ausgabedarstellung abgeschlossen ist oder wenn ein Fehler auftritt, wird ein Ereignis an ein Adobe I/O Events Journal gesendet. Clients müssen auf die Journal-URL lauschen, die über /register bereitgestellt wird. Die Journalantwort enthält ein event-Array, das aus einem Objekt für jedes Ereignis besteht, von dem das Feld event die tatsächliche Ereignis-Payload enthält.

Der Adobe I/O Events-Typ für alle Ereignisse von Asset Compute Service ist asset_compute. Das Journal wird automatisch nur für diesen Ereignistyp abonniert und es ist nicht mehr erforderlich, basierend auf dem Adobe Developer-Ereignistyp zu filtern. Die Service-spezifischen Ereignistypen stehen in der type-Eigenschaft des Ereignisses zur Verfügung.

Ereignistypen event-types

Ereignisattribute event-attributes

Metadaten metadata

Fehlerursachen error-reasons