Adobe Experience Manager Assets Nutzungsszenarien, APIs und Referenzmaterial für Entwickler

Der Artikel enthält Empfehlungen, Referenzmaterialien und Ressourcen für Entwickler von Assets as a Cloud Service. Er enthält ein neues Modul für den Asset-Upload, eine API-Referenz und Informationen über die Unterstützung, die in Nachbearbeitungs-Workflows bereitgestellt wird.

Experience Manager Assets-APIs und -Vorgänge

Assets as a Cloud Service bietet mehrere APIs für die programmgesteuerte Interaktion mit digitalen Assets. Jede API unterstützt spezifische Anwendungsfälle, wie in der folgenden Tabelle beschrieben. Die Assets-Benutzeroberfläche, das Experience Manager-Desktop-Programm und Adobe Asset Link unterstützen alle oder einige der Vorgänge.

VORSICHT

Einige APIs existieren weiterhin, werden jedoch nicht aktiv unterstützt (mit einem × gekennzeichnet). Verwenden Sie diese APIs nach Möglichkeit nicht.

Unterstützungsebene Beschreibung
Unterstützt
× Nicht unterstützt. Nicht verwenden.
- Nicht verfügbar
Nutzungsszenario aem-upload Experience Manager/Sling/JCR-Java-APIs Asset Compute Service Assets HTTP-API Sling GET/POST Servlets GraphQL
Ursprüngliche Binärdatei
Original erstellen × - × × -
Original lesen - × -
Original aktualisieren × × × -
Original löschen - - -
Original kopieren - - -
Original verschieben - - -
Metadaten
Metadaten erstellen - -
Metadaten lesen - - -
Metadaten aktualisieren - -
Metadaten löschen - -
Metadaten kopieren - - -
Metadaten verschieben - - -
Inhaltsfragmente
Inhaltsfragmente erstellen - - - -
Inhaltsfragmente lesen - - -
Inhaltsfragmente aktualisieren - - - -
Inhaltsfragmente löschen - - - -
Inhaltsfragmente kopieren - - - -
Inhaltsfragmente verschieben - - - -
Versionen
Version erstellen - - - -
Version lesen - - - - -
Version löschen - - - - -
Ordner
Ordner erstellen - - -
Ordner lesen - - - -
Ordner löschen - - -
Ordner kopieren - - -
Ordner verschieben - - -

Asset-Upload

In Experience Manager as a Cloud Service können Sie die Assets mithilfe der HTTP-API direkt in den Cloud-Speicher hochladen. Die Schritte zum Hochladen einer Binärdatei werden unten beschrieben. Führen Sie diese Schritte in einer externen Anwendung und nicht in der Experience Manager JVM aus.

  1. Senden einer HTTP-Anfrage. Diese informiert die Experience Manager-Implementierung über Ihre Absicht, eine neue Binärdatei hochzuladen.
  2. Bereitstellen (PUT) des Inhalts der Binärdatei an einen oder mehrere URIs, die von der Initiierungsanfrage bereitgestellt werden.
  3. Senden einer HTTP-Anfrage, um den Server darüber zu informieren, dass der Inhalt der Binärdatei erfolgreich hochgeladen wurde.

Überblick über das direkte binäre Upload-Protokoll

WICHTIG

Führen Sie die oben genannten Schritte in einer externen Anwendung und nicht in der Experience Manager JVM aus.

Der Ansatz bietet eine skalierbare und leistungsfähigere Handhabung von Asset-Uploads. Die Unterschiede im Vergleich zu Experience Manager 6.5 sind:

  • Binärdateien durchlaufen nicht Experience Manager, das jetzt lediglich den Upload-Prozess mit dem für die Implementierung konfigurierten binären Cloud-Speicher koordiniert.
  • Der binäre Cloud-Speicher funktioniert mit einem Content Delivery Network (CDN) oder einem Edge-Netzwerk. Ein CDN wählt einen Upload-Endpunkt aus, der für einen Client näher liegt. Wenn Daten eine kürzere Entfernung zu einem nahe gelegenen Endpunkt zurücklegen, verbessern sich die Upload-Leistung und das Benutzererlebnis, insbesondere für geografisch verteilte Teams.
HINWEIS

Informationen zum Implementieren dieses Ansatzes finden Sie im Client-Code in der Open-Source-Bibliothek aem-upload.

Initiieren des Uploads

Senden Sie eine HTTP-POST-Anfrage an den gewünschten Ordner. Assets werden in diesem Ordner erstellt oder aktualisiert. Schließen Sie den Selektor .initiateUpload.json ein, um anzugeben, dass die Anfrage darin besteht, den Upload einer Binärdatei zu starten. Der Pfad zum Ordner, in dem das Asset erstellt werden soll, lautet beispielsweise /assets/folder. Die POST-Anfrage ist POST https://[aem_server]:[port]/content/dam/assets/folder.initiateUpload.json.

Der Content-Typ des Anfragetexts sollte application/x-www-form-urlencoded-Formulardaten sein, die die folgenden Felder enthalten:

  • (string) fileName: Erforderlich. Der Name des Assets, wie er in Experience Manager angezeigt wird.
  • (number) fileSize: Erforderlich. Die Dateigröße des hochgeladenen Assets in Byte.

Eine einzige Anfrage kann dazu verwendet werden, Uploads für mehrere Binärdateien zu initiieren, solange jede Binärdatei die erforderlichen Felder enthält. Bei Erfolg wird die Anfrage mit einem 201-Status-Code und einem Text mit JSON-Daten im folgenden Format beantwortet:

{
    "completeURI": "(string)",
    "folderPath": "(string)",
    "files": [
        {
            "fileName": "(string)",
            "mimeType": "(string)",
            "uploadToken": "(string)",
            "uploadURIs": [
                "(string)"
            ],
            "minPartSize": (number),
            "maxPartSize": (number)
        }
    ]
}
  • completeURI (Zeichenfolge): Diese URI aufrufen, wenn das Hochladen der Binärdatei abgeschlossen ist. Die URI kann eine absolute oder relative URI sein. Clients sollten in der Lage sein, beide Fälle zu handhaben. Das heißt, dass der Wert "https://[aem_server]:[port]/content/dam.completeUpload.json" oder "/content/dam.completeUpload.json" sein kann. Siehe Abschließen des Hochladens .
  • folderPath (Zeichenfolge): Vollständiger Pfad zum Ordner, in den die Binärdatei hochgeladen wird.
  • (files) (Array): Eine Liste der Elemente, deren Länge und Reihenfolge mit der Länge und Reihenfolge der Liste der binären Informationen übereinstimmen, die in der Anfrage zum Initiieren bereitgestellt werden.
  • fileName (Zeichenfolge): Der Name der entsprechenden Binärdatei, wie in der Anfrage zum Initiieren angegeben. Dieser Wert sollte in der vollständigen Anfrage enthalten sein.
  • mimeType (Zeichenfolge): Der Mime-Typ der entsprechenden Binärdatei, wie der Initiierungsanfrage angegeben. Dieser Wert sollte in der vollständigen Anfrage enthalten sein.
  • uploadToken (Zeichenfolge): Ein Upload-Token für die entsprechende Binärdatei. Dieser Wert sollte in der vollständigen Anfrage enthalten sein.
  • uploadURIs (Array): Eine Liste der Zeichenfolgen, deren Werte vollständige URIs sind, in die der binäre Inhalt hochgeladen werden soll (siehe Hochladen der Binärdatei).
  • minPartSize (Zahl): Die Mindestlänge (in Byte) der Daten, die für einen der uploadURIs bereitgestellt werden können, wenn mehr als ein URI vorhanden ist.
  • maxPartSize (Zahl): Die maximale Länge (in Byte) der Daten, die für einen der uploadURIs bereitgestellt werden können, wenn mehr als ein URI vorhanden ist.

Hochladen der Binärdatei

Die Ausgabe beim Initiieren eines Uploads umfasst einen oder mehrere Upload-URI-Werte. Wenn mehr als ein URI angegeben wird, teilt der Client die Binärdatei auf und sendet PUT-Anfragen für jeden Teil in der richtigen Reihenfolge an die bereitgestellten Upload-URIs. Wenn Sie die Binärdatei in Teile aufteilen, beachten Sie die folgenden Richtlinien:

  • Jeder Teil, mit Ausnahme des letzten, muss eine Größe haben, die größer oder gleich minPartSize ist.
  • Jeder Teil muss kleiner oder gleich maxPartSize sein.
  • Wenn die Größe Ihrer Binärdatei maxPartSize überschreitet, teilen Sie die Binärdatei in Teile auf, um sie hochzuladen.
  • Sie müssen nicht alle URIs verwenden.

Wenn die Größe Ihrer Binärdatei kleiner oder gleich maxPartSize ist, können Sie stattdessen die gesamte Binärdatei in einen einzelnen Upload-URI hochladen. Wenn mehr als ein Upload-URI angegeben wird, verwenden Sie den ersten und ignorieren Sie den Rest. Sie müssen nicht alle URIs verwenden.

CDN-Edge-Knoten beschleunigen das angeforderte Hochladen von Binärdateien.

Die einfachste Möglichkeit, dies zu erreichen, besteht darin, den Wert von maxPartSize als Größe der Teile zu verwenden. Der API-Vertrag garantiert, dass ausreichend Upload-URIs zum Hochladen Ihrer Binärdatei vorhanden sind, wenn Sie diesen Wert als Größe der Teile verwenden. Teilen Sie dazu die Binärdatei in Teile mit der Größe maxPartSize auf, wobei für jeden Teil ein URI in der richtigen Reihenfolge verwendet wird. Der letzte Teil kann kleiner oder gleich maxPartSize sein. Angenommen, die Gesamtgröße der Binärdatei beträgt 20.000 Bytes, die minPartSize ist 5.000 Bytes, maxPartSize ist 8.000 Bytes und die Anzahl der Upload-URIs beträgt 5. Führen Sie die folgenden Schritte aus:

  • Laden Sie die ersten 8.000 Byte der Binärdatei mit dem ersten Upload-URI hoch.
  • Laden Sie die zweiten 8.000 Byte der Binärdatei mit dem zweiten Upload-URI hoch.
  • Laden Sie die letzten 4.000 Byte der Binärdatei mit dem dritten Upload-URI hoch. Da dies der letzte Teil ist, muss er nicht größer als minPartSize sein.
  • Sie müssen die letzten beiden Upload-URIs nicht verwenden. Sie können sie ignorieren.

Ein häufiger Fehler ist die Berechnung der Größe der Teile auf der Grundlage der Anzahl der von der API bereitgestellten Upload-URIs. Der API-Vertrag garantiert nicht, dass dieser Ansatz funktioniert, und kann tatsächlich zu Teilegrößen führen, die außerhalb des Bereichs zwischen minPartSize und maxPartSize liegen. Dies kann zu Fehlern beim Hochladen von Binärdateien führen.

Noch einmal: Am einfachsten und sichersten ist es, einfach Teile mit der Größe der maxPartSize zu verwenden.

Bei erfolgreicher Ausführung des Uploads antwortet der Server auf jede Anfrage mit Status-Code 201.

HINWEIS

Weitere Informationen zum Upload-Algorithmus finden Sie in der Offiziellen Funktionsdokumentation und in der API-Dokumentation im Apache Jackrabbit Oak-Projekt.

Abschließen des Uploads

Nachdem alle Teile einer Binärdatei hochgeladen wurden, senden Sie eine HTTP-POST-Anfrage an den vollständigen URI, der von den Initiierungsdaten bereitgestellt wird. Der Content-Typ des Anfragetexts sollte application/x-www-form-urlencoded-Formulardaten sein, die die folgenden Felder enthalten.

Felder Typ Erforderlich oder nicht Beschreibung
fileName Zeichenfolge Erforderlich Der Name des Assets, wie in den Initiierungsdaten angegeben.
mimeType Zeichenfolge Erforderlich Der HTTP-Content-Typ der Binärdatei, wie in den Initiierungsdaten angegeben.
uploadToken Zeichenfolge Erforderlich Upload-Token für die Binärdatei, wie in den Initiierungsdaten angegeben.
createVersion Boolesch Optional Wenn True und ein Asset mit dem angegebenen Namen existiert, erstellt Experience Manager eine neue Version des Assets.
versionLabel Zeichenfolge Optional Wenn eine neue Version erstellt wird, die Bezeichnung, die der neuen Version eines Assets zugeordnet ist.
versionComment Zeichenfolge Optional Wenn eine neue Version erstellt wird, die Kommentare, die der Version zugeordnet sind.
replace Boolesch Optional Wenn True und ein Asset mit dem angegebenen Namen existiert, löscht Experience Manager das Asset und erstellt es dann erneut.
uploadDuration Zahl Optional Die Gesamtzeit in Millisekunden, in der die Datei vollständig hochgeladen wurde. Falls angegeben, wird die Upload-Dauer zur Analyse der Übertragungsrate in die Protokolldateien des Systems aufgenommen.
fileSize Zahl Optional Die Größe der Datei in Byte. Falls angegeben, wird die Dateigröße zur Analyse der Übertragungsrate in die Protokolldateien des Systems aufgenommen.
HINWEIS

Wenn das Asset existiert und weder createVersion noch replace angegeben ist, aktualisiert Experience Manager die aktuelle Version des Assets mit der neuen Binärdatei.

Wie beim Initiierungsprozess können die vollständigen Anfragedaten Informationen zu mehr als einer Datei enthalten.

Das Hochladen einer Binärdatei wird erst durchgeführt, wenn die vollständige URL für die Datei aufgerufen wurde. Ein Asset wird verarbeitet, nachdem der Upload-Vorgang abgeschlossen ist. Die Verarbeitung wird nicht gestartet, auch wenn die Binärdatei des Assets vollständig hochgeladen wurde, der Upload-Vorgang jedoch nicht abgeschlossen ist. Bei erfolgreichem Upload antwortet der Server mit dem Status-Code 200.

Open-Source-Upload-Bibliothek

Um mehr über die Upload-Algorithmen zu erfahren oder eigene Upload-Skripte und -Tools zu erstellen, stellt Adobe Open-Source-Bibliotheken und -Tools bereit:

HINWEIS

Die Bibliothek aem-upload und das Befehlszeilen-Tool verwenden beide das node-httptransfer library

Veraltete APIs zum Hochladen von Assets

Die neue Upload-Methode wird nur für Adobe Experience Manager as a Cloud Service unterstützt. Die APIs aus Adobe Experience Manager 6.5 werden nicht mehr unterstützt. Die Methoden im Zusammenhang mit dem Hochladen oder Aktualisieren von Assets oder Ausgabedarstellungen (alle binären Uploads) werden in den folgenden APIs nicht mehr unterstützt:

Asset-Verarbeitungs- und Nachbearbeitungs-Workflows

In Experience Manager basiert die Asset-Verarbeitung auf der Konfiguration von Verarbeitungsprofilen, die Asset-Microservices verwendet. Für die Verarbeitung sind keine Entwicklererweiterungen erforderlich.

Verwenden Sie die standardmäßigen Workflows mit Erweiterungen mit benutzerdefinierten Schritten für die Konfiguration des Nachbearbeitungs-Workflows.

Unterstützung von Workflow-Schritten im Nachbearbeitungs-Workflow

Wenn Sie von einer früheren Version von Experience Manager aktualisieren, können Sie Asset-Microservices zur Verarbeitung von Assets verwenden. Die Cloud-nativen Asset-Microservices sind einfacher zu konfigurieren und zu verwenden. Einige Workflow-Schritte, die im DAM-Update-Asset-Workflow in der vorherigen Version verwendet wurden, werden nicht unterstützt. Weitere Informationen zu unterstützten Klassen finden Sie in der Java-API-Referenz oder in den Javadocs.

Die folgenden technischen Workflow-Modelle werden entweder durch Asset-Microservices ersetzt oder es ist kein Support verfügbar:

  • com.day.cq.dam.cameraraw.process.CameraRawHandlingProcess
  • com.day.cq.dam.core.process.CommandLineProcess
  • com.day.cq.dam.pdfrasterizer.process.PdfRasterizerHandlingProcess
  • com.day.cq.dam.core.process.AddPropertyWorkflowProcess
  • com.day.cq.dam.core.process.CreateSubAssetsProcess
  • com.day.cq.dam.core.process.DownloadAssetProcess
  • com.day.cq.dam.word.process.ExtractImagesProcess
  • com.day.cq.dam.word.process.ExtractPlainProcess
  • com.day.cq.dam.ids.impl.process.IDSJobProcess
  • com.day.cq.dam.indd.process.INDDMediaExtractProcess
  • com.day.cq.dam.indd.process.INDDPageExtractProcess
  • com.day.cq.dam.core.impl.lightbox.LightboxUpdateAssetProcess
  • com.day.cq.dam.pim.impl.sourcing.upload.process.ProductAssetsUploadProcess
  • com.day.cq.dam.core.process.SendDownloadAssetEmailProcess
  • com.day.cq.dam.similaritysearch.internal.workflow.smarttags.StartTrainingProcess
  • com.day.cq.dam.similaritysearch.internal.workflow.smarttags.TransferTrainingDataProcess
  • com.day.cq.dam.switchengine.process.SwitchEngineHandlingProcess
  • com.day.cq.dam.core.process.GateKeeperProcess
  • com.day.cq.dam.s7dam.common.process.DMEncodeVideoWorkflowCompletedProcess
  • com.day.cq.dam.core.process.DeleteImagePreviewProcess
  • com.day.cq.dam.video.FFMpegTranscodeProcess
  • com.day.cq.dam.core.process.ThumbnailProcess
  • com.day.cq.dam.video.FFMpegThumbnailProcess
  • com.day.cq.dam.core.process.CreateWebEnabledImageProcess
  • com.day.cq.dam.core.process.CreatePdfPreviewProcess
  • com.day.cq.dam.s7dam.common.process.VideoUserUploadedThumbnailProcess
  • com.day.cq.dam.s7dam.common.process.VideoThumbnailDownloadProcess
  • com.day.cq.dam.s7dam.common.process.VideoProxyServiceProcess
  • com.day.cq.dam.scene7.impl.process.Scene7UploadProcess
  • com.day.cq.dam.s7dam.common.process.S7VideoThumbnailProcess
  • com.day.cq.dam.core.process.MetadataProcessorProcess
  • com.day.cq.dam.core.process.AssetOffloadingProcess
  • com.adobe.cq.dam.dm.process.workflow.DMImageProcess

Auf dieser Seite