Services standard

Le tableau ci-dessous présente les services standard d'Unica Content Integration. Par conséquent, aucun des noms de service répertoriés ici ne doit être utilisé pour une implémentation de service personnalisée. Le SDK de Content Integration fournit des interfaces et des types standard pour implémenter ces services standard. Ces interfaces et types sont abordés plus en détail dans les sections suivantes.

Tableau 1. Services standard et leur description
Nom du service standard Description
simple-search
Le service Recherche simple répond aux demandes de recherche de contenu reçues par Content Integration Framework. Ce service accepte la chaîne de requête de recherche avec les détails de pagination des résultats requis. En fonction du succès de l'opération de recherche, il renvoie le résultat de la recherche pour une requête de recherche donnée et en fonction de la pagination requise. Il s'agit d'un service obligatoire pour le plug-in.
list-folders Ce service est facultatif. Folder est un terme générique utilisé pour représenter un objet de conteneur utilisé dans le système cible pour organiser hiérarchiquement le contenu. Ce service est appelé pour rendre la liste des dossiers et des sous-dossiers afin de faciliter la navigation dans ces contenus organisés hiérarchiquement.
Remarque : list-folders et list-contents sont des services corrélés. L'implémentation des deux services doit exister pour que la navigation de contenu fonctionne correctement.
list-contents Ce service est facultatif. Ce service est appelé pour répertorier le contenu appartenant à un dossier particulier.
Remarque : list-folders et list-contents sont des services corrélés. L'implémentation des deux services doit exister pour que la navigation de contenu fonctionne correctement.
get-content-details L'implémentation de ce service est utile pour récupérer les détails d'un contenu individuel. Le contenu obtenu à l'aide de simple-search et list-contents services est référencé plus loin dans d'autres produits Unica. Ultérieurement, il est possible que des utilisateurs souhaitent voir les détails d'un contenu déjà référencé. Par conséquent, nous vous invitons à implémenter ce service pour permettre aux utilisateurs de voir les détails de contenus à la demande.
get-object-schema Ce service est facultatif. L'implémentation de ce service est utile pour permettre aux utilisateurs de Centralized Offer Management de mapper des attributs de contenu à des attributs d'offre, puis d'extraire les valeurs des attributs d'offre mappés à partir des attributs de contenu correspondants en sélectionnant le contenu souhaité dans Content Picker. Par conséquent, s'il est implémenté, ce service facilite l'utilisation d'autres attributs de contenu en plus des URL de contenu pour la création d'offre.
resource-loader Ce service est utile lorsque le téléchargement direct du contenu à partir du système cible n'est pas possible. Ce service n'est pas obligatoire et ne doit être mis en œuvre que lorsque les complications suivantes se présentent :
  • S'il n'existe aucun lien Web direct pour télécharger le contenu

    Le contenu renvoyé par les services simple-search et list-contents doit inclure une URL menant au contenu respectif afin que le client Content Integration puisse le télécharger directement via Internet. Si un tel lien direct vers le contenu n'est pas présent, il est nécessaire d'implémenter le service resource-loader en remplaçant l'implémentation par défaut fournie par Content Integration Framework. Par exemple, si le contenu est conservé dans une table de base de données, les services simple-search et list-contents récupèreront les enregistrements depuis la base de données. Etant donné que les éléments sont chargés à partir de la base de données, il peut ne pas y avoir d'URL pointant directement vers chaque enregistrement. Dans ce cas, le service resource-loader peut utiliser l'identificateur de contenu pour localiser et fournir les données appropriées chaque fois que le téléchargement de contenu est demandé. Toutes les demandes de téléchargement de contenu passeront par Content Integration Framework, qui déléguera la tâche de téléchargement au service resource-loader en lui fournissant l'URL du contenu et son identificateur.

  • Si les liens Web vers le contenu sont protégés

    Il est possible que certains systèmes ne fournissent pas un accès anonyme au contenu malgré la disponibilité de liens Web directs. Dans ces cas-là, l'accès est généralement fourni uniquement après avoir fourni les détails d'authentification requis. Par défaut, Content Integration Framework enregistre une implémentation de service prête à l'emploi du service resource-loader pour chaque plug-in. Cette implémentation par défaut utilise la véritable URL du contenu pour télécharger le contenu à partir du système distant en fournissant les détails d'authentification appropriés sujets aux configurations à Unica Platform. (Pour plus d'informations sur les configurations d'intégration du système, voir Unica Content Integration - Guide d'administration).

    Sinon, les plug-ins peuvent aussi remplacer l'implémentation resource-loader par défaut pour modifier le comportement de téléchargement de contenu (à l'aide de l'URL ou de l'identificateur de contenu). Si le service resource-loader est pris en charge à l'aide de l'approche RESTful, Content Integration Framework continuera à fournir des détails d'authentification basés sur la configuration de Platform.

    Remarque : Le contenu doit être rendu accessible de manière anonyme s'il doit être consultable/accessible par un public extérieur. Dans ce cas, l'utilisation du service resource-loader n'est pas encouragée dans les systèmes de production. L'utilisation du service resource-loader peut être désactivée à tout moment en définissant la propriété Contenu anonyme sur Oui dans la configuration de Platform. De même, il peut être activé en définissant la même propriété sur Non.
list-content-categories Le contenu peut être catégorisé de manière logique à l'aide de sa classification naturelle. Par exemple, le contenu numérique peut être catégorisé en Images, Documents, Multimédia (audios et vidéos), Archives, etc. De même, les produits de commerce électronique peuvent être catégorisés en plusieurs catégories générales, telles que Electronique, Soins de santé, Livres, Meubles, etc. Content Integration Framework offre les façons suivantes pour transmettre ces catégorisations de contenu de manière à faciliter la recherche de contenus au sein d'une catégorie spécifique.
  • supportedContentTypes paramètre de service

    Un paramètre de niveau de service standard, supportedContentTypes, peut être utilisé pour fournir de manière statique un dictionnaire de types de contenu pris en charge sous la déclaration de service simple-search.

  • getSupportedContentTypes() méthode dans l'implémentation du service de recherche

    La méthode getSupportedContentTypes() peut être remplacée pour générer dynamiquement une mappe de types de contenu pris en charge, où la clé sert d'identificateur de catégorie et la valeur sert de libellé affiché dans l'interface utilisateur. Cette méthode est exécutée lors du démarrage de l'application. Par conséquent, aucun appel d'API distant ne peut être effectué à l'aide des capacités de Content Integration Framework, car il est possible que l'application ne soit pas totalement initialisée lorsque cette méthode est appelée.

  • list-content-categories service

    Le service list-content-categories peut éventuellement être implémenté pour répondre à la limitation de la méthode getSupportedContentTypes(). Il permet d'effectuer des appels d'API distants pour extraire les catégories de contenu de manière encore plus dynamique. S'il est implémenté, ce service remplace les approches mentionnées précédemment. Content Integration Framework appelle ce service chaque fois que la fenêtre contextuelle de recherche de contenu est rendue.

get-cognitive-analysis Ce service est facultatif. S'il est implémenté, il est utilisé pour extraire les détails cognitifs associés à l'image donnée, sous réserve de la configuration du « Fournisseur de services cognitifs préféré » dans Unica Platform.