Communauté

Doc produitsMenu

Installation de l'API Coveo Search

L’API Coveo Search met en œuvre un point de terminaison de recherche REST qui peut être utilisé par d’autres produits de Coveo pour communiquer avec votre index local de Coveo Enterprise Search (CES) (voir À propos de l'API Coveo Search). Vous pouvez installer l’API Coveo Search dans un serveur de votre choix tel que le serveur maître de Coveo (où Coveo Enterprise Search est installé), dans un serveur d’interface (où Coveo JavaScript Search est installé) ou dans tout autre serveur. Une fois installé, l’API Coveo Search est disponible en tant que service Windows.

Lorsque votre déploiement inclut une ou plusieurs interfaces Coveo JavaScript Search, vous devez installer et configurer un API Coveo Search.

Notes :

  • Coveo for Sitecore utilise à la fois JavaScript Search et l’API Coveo Search, mais les deux sont déployés par le programme d’installation de Coveo for Sitecore (voir Installing Coveo for Sitecore).

  • Vous pouvez également implanter l’API Coveo Search dans des applications ASP.NET ou Java (voir Installation Options).

Pour installer l’API Coveo Search

  1. À l’aide d’un compte d’administrateur, connectez-vous au serveur dans lequel vous avez décidé d’installer l’API Coveo Search.

  2. Téléchargez la dernière version du programme d’installation de l’API Coveo Search.

  3. Exécutez le programme d’installation de l’API Coveo Search (Coveo Search API 8.0.nnn.exe).

  4. Quand une version précédente de l’API Search a été déployée avec la distribution du fichier ZIP et définie en tant que service Windows, vous verrez le message suivant. Vous devez arrêter et désinstaller l’ancien service (Coveo REST Search API) avant de continuer l’installation.

    1. Cliquez sur OK, et dans l'écran Installation Cannot Proceed, cliquez sur Finish.

    2. Ouvrez la console de gestion Services, et trouvez le service CoveoSearchAPI.

    3. Dans le dossier où vous avez extrait le fichier ZIP, exécutez le fichier de commandes Uninstall.bat.

    4. Redémarrez le programme d’installation de l’API Coveo Search.

  5. Dans l’écran Installation Folder :

    1. Lorsque le dossier d’installation par défaut est inapproprié (C:\Program Files\Coveo Search API 8\), sélectionnez le dossier désiré.

    2. Lorsque vous installez l’API Coveo Search dans le contexte d’un déploiement de Coveo for Sitecore, cochez This installation is part of a Sitecore installation.

    3. Cliquez sur Suivant.

  6. Si vous avez coché This installation is part of a Sitecore installation, dans l’écran Application Secret Token, cliquez sur Generate Random Token pour créer un jeton de secret d’application qui sera utilisé par Coveo for Sitecore, puis cliquez sur Next.

  7. Dans l'écran Prêt pour l'installation, cliquez sur Installer.

  8. Dans l'écran Installation Successful :

    1. Lorsque vous déployez une nouvelle installation de l’API Coveo Search et n’avez pas coché This installation is part of a Sitecore installation, le programme d’installation ne peut faire démarrer le service de l’API Coveo Search.

      Vous devez d’abord modifier le fichier de configuration par défaut pour spécifier le serveur Coveo qui héberge l’index (si ce n'est pas localhost) et fort probablement pour sécuriser l’accès à l’API REST.

      Cliquez sur Open config.yml pour modifier le fichier de configuration (par défaut C:\Program Files\Coveo Search API 8\config.yml) avec un éditeur de texte de votre choix (voir Personnalisation et démarrage de l’API Coveo Search).

      Note : Vous avez peut-être besoin de définir l’application de votre ordinateur qui ouvrira les fichiers YAML (extension (.yml) par défaut. Choisissez un éditeur de texte comme Notepad.

    2. Cliquez sur Finish.

Lorsque vous cochez This installation is part of a Sitecore installation, le programme d’installation configure et démarre le service de l’API Coveo Search.