How can we integerate Coveo with AEM Headless cms?

Question

Hi,I am going to prepare a document on Coveo search integration in AEM Headless CMS for the client. I didn't find any documentation on  Coveo with AEM Headess if You have any ideas please post u r ideas Thanks,Syed Shaik.

PRATHYUSHA_VP · Accepted Answer

Hi @syed_shaik

We can integrate coveo search in AEM headless projects. Below are the examples where you can find examples of how to integrate using npm packages

Create an API key authentication in Coveo platform and set the API key and search hub in the configuration object as below -

import { buildSearchEngine, getSampleSearchEngineConfiguration } from '@coveo/headless';
export const headlessEngine = buildSearchEngine({
  configuration: {
    search: {
      searchHub: "Public docs search"
    },
    organizationId: "mycoveoorganization",
    accessToken: "a1b2c3d4-e5f6-g7h8-i9j0-k11l12m13n14",
  }
});

Refer below docs for more information :

https://docs.coveo.com/en/105/build-a-search-ui/use-api-key-authentication-with-the-search-api

https://docs.coveo.com/en/headless/latest/usage/

https://docs.coveo.com/en/headless/latest/usage/headless-code-samples/

Hope this helps

Thanks

Uppari_Ramesh · Answer

Hi @syed_shaik , If your organization is capable of using third party connctor which is already developed to integrate aem with coveo then you can use Perficient handshake connector. This tool has lot of features to index the content in coveo from aem.

If not in position to use tool then PFB

1. From coveo side you need to create a push source in coveo portal.

2. Once you create a push source in coveo portal then you will be able to get coveo search api key and push api key. You can also create a separate pipeline for this source.

3. Search api key used to get a JWT as response from coveo and this JWT is used to make a request to coveo when user search for something in website.

4. To push the AEM pages or assets from aem to coveo, you need coveo push api end point and also push api keys.

5. You can call the coveo push api endpoint when your content is activated or deactivated. I mean on replication status.

6. As a better approach the push api and search token api keys has to crypto encoded and stored in OSGI configs. During runtime decode it and get the actual key.

7. To call any coveo api, coveo documentation is clear and it will tell you what are all you need to pass and what you receive . Go thru below.

https://docs.coveo.com/en/68/index-content/use-the-push-api

https://docs.coveo.com/en/56/build-a-search-ui/use-search-token-authentication

Thanks

Ramesh

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded