- Coveo Control Panel Administration Access
- Understanding the Command Center
- Introduction to the Coveo Configuration files
- Understanding the Coveo Search Provider Configuration File
- Managing Your License
- Understanding the REST Endpoint Configuration Files
- Changing the Default Coveo for Sitecore REST Endpoint Proxy Path
- Accessing the Coveo for Sitecore API
Understanding the REST Endpoint Configuration Files
To make this communication work, the Coveo Search REST endpoint relies on two very important components. The first one is a custom HTTP handler that is seen as the REST endpoint itself. Its default location in the website is
/coveo/rest. The second component is the Search API service, which is usually installed along with the Coveo Enterprise Search (CES) instance for On-Premises installations, and available in Coveo Cloud for Cloud installations. The Search API service is responsible for querying the search index.
Understanding the Coveo Search Provider’s Configuration File (
Those are the basic settings that must be configured initially. They can be found under the
The API key of the Cloud organization that is being queried.
When you log in to a Coveo Cloud organization using the Configuration Wizard, an API key is stored in its encrypted form in the configuration file.
||The secret key that is configured in the Search API service. This key is required so that the search API can trust the Sitecore application.||
||The ID of the Cloud organization that is being queried.|
||The timeout period for requests going through the search API proxy.||
||Defines the location of the REST endpoint in the Sitecore website.||
||Defines the period when the search token is valid.||
||The URI to connect to the Search API service, or to the Cloud REST endpoint.||
Example of a Cloud Configuration
By default, since everything is already defined in the configuration of the cloud platform, the content of every node will be a reference to the cloud platform configuration node corresponding to the required value.
<restEndpointConfiguration> <searchApiUri ref="coveo/cloudPlatformConfiguration/cloudPlatformUri" /> <apiKey ref="coveo/cloudPlatformConfiguration/apiKey" /> <organizationId ref="coveo/cloudPlatformConfiguration/organizationId" /> <analyticsUri>https://usageanalytics.coveo.com</analyticsUri> </restEndpointConfiguration>