Sök i Assets API search-assets-api
Alla godkända resurser som är tillgängliga i Experience Manager-resurskatalogen kan genomsökas och sedan levereras till integrerade program längre fram i kedjan med en leverans-URL.
Att söka efter rätt godkända resurser från Experience Manager-databasen är det första steget mot att leverera resurser med hjälp av URL:en för leverans. Svaret på sökbegäran består av en array med JSON-dokument som motsvarar de resurser som uppfyller sökvillkoren. Varje JSON-dokument identifieras med hjälp av ett id
-fält, som används för att disponera för resursleverans.
Du kan definiera egenskaper i Search Assets API-begäran för att aktivera följande funktioner:
-
Fulltextsökning: Använd frågan
match
för att definiera texten som ska sökas igenom. Du kan också använda operatorer imatch
-frågan för att filtrera resultaten. -
Använd filter: Använd frågan
term
om du vill filtrera resultaten ytterligare genom att definiera enkey
och ett eller flera värden.key
identifierar fältet vars värde måste matchas ochvalue
representerar det som ska matchas. På samma sätt kan du använda fråganrange
för att definiera ett intervall för ett fält med egenskaperna Större än (gt), Större än eller lika med (get), Mindre än (lt) och Mindre än eller lika med (lte). -
Sortera resultat: Använd egenskapen
OrderBy
för att sortera sökresultat baserat på ett eller flera fält. Du kan sortera resultatet i stigande eller fallande ordning. -
Sidnumrering: Använd egenskaperna
limit
ochcursor
för att definiera sidnumreringsegenskaper i en sökning-API-begäran. Egenskapenlimit
definierar det maximala antalet objekt som ska hämtas i ett API-svar. Egenskapencursor
gör det lättare att hämta startpunkten för nästa uppsättning resurser som definieras i egenskapenlimit
. Om du till exempel definierar50
som gräns i API-begäran kan du använda egenskapencursor
för att starta och hämta de kommande 50 objekten med nästa API-begäran.
API-slutpunkt för sökresurser search-assets-api-endpoint
Slutpunkten i en API-begäran för sökresurser måste ha följande format:https://delivery-pXXXX-eYYYY.adobeaemcloud.com/adobe/assets/search
Leveransdomänen har liknande struktur som Experience Manager författarmiljöns domän. Den enda skillnaden är att termen author
ersätts med delivery
.
pXXXX
refererar till program-ID
eYYYY
refererar till miljö-ID
API-begärandemetoden för sökresurser search-assets-api-request-method
POST
Sök i Assets API-huvud search-assets-api-header
Du måste ange följande information när du definierar en rubrik i API:t för sökresurser:
headers: {
'Content-Type': 'application/json',
'X-Adobe-Accept-Experimental': '1',
Authorization: 'Bearer <YOUR_JWT_HERE>',
'X-Api-Key': 'YOUR_API_KEY_HERE'
},
Om du vill anropa söknings-API:t krävs en IMS-token för att definiera informationen i Authorization
. IMS-token hämtas från ett tekniskt konto. Se Hämta AEM as a Cloud Service-autentiseringsuppgifter för att skapa ett nytt tekniskt konto. Se Generera åtkomsttoken för att generera IMS-token och använda den korrekt i API-begärandehuvudet för sökresurser.
Om du vill visa exempel på begäranden, svarsexempel och svarskoder kan du läsa Sök i Assets API.