Communauté

Doc produitsMenu

Personnalisation et démarrage de l’API Coveo Search

L'API Coveo Search agit en tant que lien entre les interfaces ou applications de recherche du front-end et une instance de Coveo Enterprise Search (CES) qui maintient un index dans le back-end (voir À propos de l'API Coveo Search).

Après avoir installé une copie neuve de l’API de recherche Coveo (voir Installation de l'API Coveo Search) ou quand vous souhaitez modifier la façon dont le service fonctionne, vous devez modifier le fichier de configuration de l’API de recherche Coveo.

Le fichier de configuration de l’API de recherche Coveo :

  • Est disponible dans le dossier racine de l’API de recherche Coveo, par défaut C:\Program Files\Coveo Search API 8\config.yml.

  • Est en format YAML, un format de fichier de données facile à lire dans lequel l’indentation des éléments détermine la structure des données (voir www.yaml.org).

    Important : L’indentation doit être effectuée par deux espaces, pas des tabulations. L’utilisation de tabulations entraînera une erreur de syntaxe et le service s’arrêtera immédiatement lorsque vous essayez de le démarrer.

  • Est composée de diverses sections renfermant un ou plusieurs paramètres (voir Windows Service Configuration File).

Le fichier de configuration par défaut ne contient que certains des paramètres et sections pour vous aider à spécifier facilement le serveur d’index et les options communes pour sécuriser l’API. La procédure suivante décrit comment configurer les paramètres communs.

Pour personnaliser et démarrer l’API de recherche Coveo

  1. À l’aide d’un compte d’administrateur, connectez-vous au serveur dans lequel l’API de recherche Coveo est installé.

  2. À l’aide d’un éditeur de texte, ouvrez le fichier [Search_API_Install_Path]\config.yml (par défaut C:\Program Files\Coveo Search API 8\config.yml).

  3. Dans la section server du fichier :

    Exemple : L’API de recherche Coveo est installé dans le même serveur que CES (myCoveoMasterServer) et utilise le port par défaut (52810). 

    server: uri: https://myCoveoMasterServer:52810 serverCertificatePath: E:\CES70\Config\Certificates\cert-ca.pem clientCertificatePath: E:\CES70\Config\Certificates\cert-iis.p12

    1. Pour le paramètre uri, entrez l’URI de votre serveur maître Coveo (où Coveo Enterprise Search est installé) qui héberge l’index unifié avec lequel vous souhaitez que cet API REST envoie des requêtes et reçoive des résultats de recherche.

      Lorsque l’API de recherche Coveo est dans le même serveur que CES, l’uri par défaut (https://localhost:52810) fonctionnera.

      Lorsque votre serveur maître de Coveo n’utilise pas le port de service par défaut (52810), saisissez le port qu’il utilise.

    2. Pour les paramètres serverCertificatePath et clientCertificatePath, saisissez le chemin d’accès local où, respectivement, le serveur CES et les certificats de client peuvent être retrouvés. L’API REST utilisera ces certificats pour s’authentifier avec le serveur d’index.

      Note : Lorsque l’API de recherche Coveo est dans un serveur différent de CES, vous devez copier les fichiers de certificat à partir du serveur maître de Coveo (typiquement du dossier [Index_Path]\Config\Certificates\ jusqu’au chemin d’accès que vous entrez dans le serveur où l’API de recherche Coveo est installé).

  4. Dans les sections basicAuthentication, windowsAuthentication et guest du fichier, déterminez si et comment les utilisateurs qui effectuent la recherche doivent être authentifiés pour être autorisés à obtenir des résultats de l’API :

    Exemple : Avec cette configuration, seuls les utilisateurs d’Active Directory obtiennent des résultats. 

    basicAuthentication: enabled: false provider: Active Directory windowsAuthentication: enabled: true provider: Active Directory guest: enabled: false name: DOMAIN\user provider: Active Directory

    1. Pour le paramètre enabled, entrez true lorsque vous souhaitez activez ce mode d’authentification.

      Note : basicAuthentication fait passer les paramètres de connexion en texte clair afin qu’ils puissent toujours être utilisés avec des connexions HTTPS (SSL) sécurisées ou seulement pour les tests internes.

    2. Pour le paramètre provider, entrez le nom du fournisseur de sécurité que CES utilisera pour valider l’authentification.

      Note : Vous pouvez trouver le nom du fournisseur de sécurité dans la page Security Providers de l’Outil d’administration de CES.

    Exemple : Lorsque l’API peut être accessible publiquement par n’importe qui, vous pouvez activer le mode d’authentification guest pour le groupe d’identificateur de sécurité bien connu S-1-1-0 Windows (Active Directory) Everyone. 

    guest: enabled: true name: S-1-1-0 provider: Active Directory type: Group

  5. Lorsqu’une ou plusieurs applications web utiliseront cet API, identifiez des jetons ou des GUID que les applications devront fournir afin d’avoir l’autorisation d’utiliser l’API et que vous ne communiquerez qu’aux parties fiables (voir On-Premises Search Token Authentication) :

    Exemple : Les interfaces de recherche de votre site web et votre Intranet utilisent cet API. 

    tokens: sharedKey: a0534332-f093-4064-a712-4a79a97c9227 applications: - name: Website search secret: 353c7d37-7445-4217-a0ba-52c772c05632 allowImpersonate: false - name: Intranet search secret: 8eSHODDPqGiMvqVY4vwNDut7sdRgwhovSQlAWDLr1nTwSzJi2lDiK allowImpersonate: false

    1. Dans la section tokens du fichier, le paramètre sharedKey ne doit être défini que dans des cas spécifiques (voir Configuring Search Token Generation). Quand c’est le cas, générez et entrez un GUID à utiliser comme jeton de clé partagé.

    2. Dans la section applications du fichier, créez une sous-section commençant par un tiret pour chaque application que vous souhaitez autoriser à utiliser cet API :

      1. Pour le paramètre name, entrez un nom de votre choix qui identifiera cette application. Le nom n’est que pour votre référence dans ce fichier.

      2. Pour le paramètre secret, générez et entrez un GUID à utiliser comme jeton secret d'application.

      3. Pour le paramètre allowImpersonate, laissez-le à false, sauf si l’application doit effectuer de la recherche au nom de quelqu’un d’autre sans avoir à fournir le mot de passe.

        Exemple : Avec Coveo for Salesforce, l’utilisateur qui effectue une recherche est authentifié dans Salesforce. L’application de recherche obtient le compte d’utilisateur de Salesforce (email) et est définie afin de personnifier cet utilisateur pour ne retourner que des documents que cet utilisateur a les permissions de voir.

  6. Enregistrez le fichier.

    Note : Vous pouvez ajouter plusieurs autres paramètres pour contrôler de manière plus spécifique comment votre API de recherche Coveo fonctionne (voir Windows Service Configuration File).

  7. Démarrez le service de l’API de recherche Coveo :

    1. Ouvrez la console de gestion Services de Windows.

    2. Trouvez et cliquez avec le bouton droit de la souris sur le service Coveo Search API, puis cliquez sur Start.

    3. Veillez à ce que le service démarre.

      Note : Le service s’interrompt immédiatement si le fichier config.yml contient une erreur de syntaxe telle qu’une tabulation, qui est un caractère invalide dans le format YAML (voir REST Search API Windows Service Stops).

  8. Vous pouvez valider que le service est accessible à partir de divers ordinateurs :

    1. À l’aide d’un navigateur, accédez à l’URL dans le format suivant :

      http://[REST_API_SERVER]:[port]/rest/search

      Exemples :

      • À partir du même serveur où le port est, par défaut, (8080) :

        http://localhost/rest/search

      • À partir d’un autre ordinateur quand le port n’est pas celui par défaut :

        http://myRestApiServer:80/rest/search

    2. Validez que la réponse Jason de l’API REST apparaît dans le navigateur.