Recherche dans l’API Assets search-assets-api
Toutes les ressources approuvées disponibles dans le référentiel de ressources Experience Manager peuvent être recherchées, puis diffusées aux applications intégrées en aval à l’aide d’une URL de diffusion.
La recherche des ressources approuvées appropriées à partir du référentiel Experience Manager constitue la première étape de la diffusion des ressources à l’aide de l’URL de diffusion. La réponse à la requête de recherche comprend un tableau de documents JSON correspondant aux ressources qui répondent aux critères de recherche. Chaque document JSON est identifié à l’aide d’un champ id, qui est utilisé pour composer la demande de remise de ressources.
Vous pouvez définir des propriétés dans la requête API Search Assets pour activer les fonctionnalités suivantes :
-
Recherche de texte intégral : utilisez la requête
matchpour définir le texte à rechercher. Vous pouvez également utiliser des opérateurs dans la requêtematchpour filtrer les résultats. -
Appliquer les filtres : utilisez la requête
termpour filtrer davantage les résultats en définissant unekeyet une ou plusieurs valeurs.keyidentifie le champ dont la valeur doit correspondre etvaluereprésente ce à quoi la correspondance doit être effectuée. De même, vous pouvez utiliser la requêterangepour définir une plage pour un champ à l’aide des propriétés Supérieur à (gt), Supérieur ou égal à (gte), Inférieur à (lt) et Inférieur ou égal à (lte). -
Trier les résultats : utilisez la propriété
OrderBypour trier les résultats de recherche en fonction d’un ou de plusieurs champs. Vous pouvez trier les résultats par ordre croissant ou décroissant. -
Pagination : utilisez les propriétés
limitetcursorpour définir les propriétés de pagination dans une requête d’API de recherche. La propriétélimitdéfinit le nombre maximal d’éléments à récupérer dans une réponse API. La propriétécursorfacilite la récupération du point de départ pour l’ensemble suivant de ressources définies dans la propriétélimit. Par exemple, si vous définissez50comme limite dans la requête API, vous pouvez utiliser la propriétécursorpour démarrer et récupérer les 50 éléments suivants à l’aide de la requête API suivante.
Point d’entrée de l’API de recherche de ressources search-assets-api-endpoint
Le point de terminaison d’une requête de l’API Assets de recherche doit être au format suivant :https://delivery-pXXXX-eYYYY.adobeaemcloud.com/adobe/assets/search
Le domaine de diffusion est similaire en termes de structure au domaine de l’environnement de création Experience Manager. La seule différence est de remplacer le terme author par delivery.
pXXXX fait référence à l’ID de programme
eYYYY fait référence à l’ID d’environnement
Méthode de requête de l’API de recherche de ressources search-assets-api-request-method
POST
En-tête de l’API de recherche Assets search-assets-api-header
Vous devez fournir les détails suivants lors de la définition d’un en-tête dans l’API de recherche de ressources :
headers: {
'Content-Type': 'application/json',
'X-Adobe-Accept-Experimental': '1',
Authorization: 'Bearer <YOUR_JWT_HERE>',
'X-Api-Key': 'YOUR_API_KEY_HERE'
},
Pour appeler l’API de recherche, un jeton IMS est nécessaire pour définir dans les détails Authorization. Le jeton IMS est récupéré à partir d’un compte technique. Voir Récupération des informations d’identification AEM as a Cloud Service pour créer un compte technique. Voir Génération du jeton d’accès pour générer le jeton IMS et l’utiliser de manière appropriée dans l’en-tête de requête de l’API de ressources de recherche.
Pour afficher des exemples de requête, des exemples de réponse et des codes de réponse, reportez-vous à la section API Search Assets.