API zum Durchsuchen von Assets search-assets-api
Alle genehmigten Assets, die im Experience Manager-Asset-Repository verfügbar sind, können durchsucht werden und anschließend mithilfe einer Bereitstellungs-URL an integrierte nachgelagerte Anwendungen gesendet werden.
Die Suche nach den richtigen genehmigten Assets im Experience Manager-Repository ist der erste Schritt bei der Bereitstellung von Assets mithilfe der Bereitstellungs-URL. Die Antwort auf die Suchanfrage umfasst ein Array von JSON-Dokumenten, die den Assets entsprechen, die die Suchkriterien erfüllt haben. Jedes JSON-Dokument wird mithilfe eines id-Feldes identifiziert, das zum Erstellen der Asset-Bereitstellungsanfrage verwendet wird.
Sie können Eigenschaften in der Anfrage der API zum Durchsuchen von Assets definieren, um die folgenden Funktionen zu aktivieren:
-
Volltextsuche durchführen: Verwenden Sie die
match-Abfrage, um den zu suchenden Text zu definieren. Sie können außerdem die Ergebnisse mithilfe von Operatoren innerhalb dermatch-Abfrage filtern. -
Filter anwenden: Verwenden Sie die
term-Abfrage, um die Ergebnisse weiter zu filtern, indem Sie einenkeyund einen oder mehrere Werte definieren.keygibt das Feld an, dessen Wert abgeglichen werden muss, undvaluebestimmt, womit abgeglichen werden soll. Auf ähnliche Weise können Sie mit derrange-Abfrage einen Bereich für ein Feld definieren, indem Sie die Eigenschaften „Größer als“ (gt), „Größer gleich“ (gte), „Kleiner als“ (lt) und „Kleiner gleich“ (lte) verwenden. -
Ergebnisse sortieren: Verwenden Sie die Eigenschaft
OrderBy, um Suchergebnisse basierend auf einem oder mehreren Feldern zu sortieren. Sie können die Ergebnisse in auf- oder absteigender Reihenfolge sortieren. -
Paginierung: Verwenden Sie die Eigenschaften
limitundcursor, um Paginierungseigenschaften in einer Such-API-Anfrage zu definieren. Die Eigenschaftlimitdefiniert die maximale Anzahl von Elemente, die im Rahmen einer API-Antwort abgerufen werden soll. Die Eigenschaftcursorvereinfacht den Abruf des Startpunkts für den nächsten Satz von Assets, der in der Eigenschaftlimitdefiniert ist. Wenn Sie beispielsweise50als Limit in der API-Anfrage definieren, können Sie mit der Eigenschaftcursordie nächsten 50 Elemente mit der nächsten API-Anfrage abrufen.
Endpunkt bei der API zum Durchsuchen von Assets search-assets-api-endpoint
Der Endpunkt in einer Anfrage der API zum Durchsuchen von Assets muss das folgende Format aufweisen:https://delivery-pXXXX-eYYYY.adobeaemcloud.com/adobe/assets/search
Die Bereitstellungs-Domain ähnelt der Struktur der Domain der Autorenumgebung von Experience Manager. Der einzige Unterschied ist das Ersetzen des Begriffs author durch delivery.
pXXXX bezeichnet die Programm-ID
eYYYY bezeichnet die Umgebungs-ID
Anfragemethode der API zum Durchsuchen von Assets search-assets-api-request-method
POST
Header der API zum Durchsuchen von Assets search-assets-api-header
Beim Definieren eines Headers in der API zum Durchsuchen von Assets müssen Sie die folgenden Details angeben:
headers: {
'Content-Type': 'application/json',
'X-Adobe-Accept-Experimental': '1',
Authorization: 'Bearer <YOUR_JWT_HERE>',
'X-Api-Key': 'YOUR_API_KEY_HERE'
},
Um die Such-API aufzurufen, ist ein IMS-Token erforderlich, das in den Authorization-Details definiert wird. Das IMS-Token wird aus einem technischen Konto abgerufen. Informationen zum Erstellen eines neuen technischen Kontos finden Sie unter Abrufen der Anmeldedaten für AEM as a Cloud Service. Informationen zum Generieren des IMS-Tokens und zu seiner entsprechenden Verwendung im Anfrage-Header der API zum Durchsuchen von Assets finden Sie unter Generieren des Zugriffs-Tokens.
Anfragebeispiele, Antwortbeispiele und Antwort-Codes finden Sie unter API zum Durchsuchen von Assets.