Integrating with Adobe Search&Promote

To call the Adobe Search&Promote service from your website, perform the following tasks:

  1. Specify the URL of the Cloud.
  2. Configure the connection to the Search&Promote service.
  3. Add Search&Promote components to Sidekick.
  4. Use the components to author the content. (See Adding Search&Promote Features to a Web Page.)
  5. Add banners to your pages. Banner images are sensitive to Search&Promote data.
  6. Generate a site map for the Search&Promote service to consume.

If you are using Search&Promote with a custom proxy configuration, you need to configure both HTTP Client proxy configurations as some functionalities of AEM are using the 3.x APIs and some others the 4.x APIs:

Changing the Search&Promote service URL

The default URL that is configured for the Search&Promote service is To use a different service, use the OSGi console to specify a different URL.

To change the Search&Promote service URL:

  1. Open the OSGi console and tap the Configuration tab. (http://localhost:4502/system/console/configMgr.)

  2. Click the Day CQ Search&Promote Configuration item.

  3. In the Remote Server URI text field, enter the URL, then tap Save.

Configuring the connection to Search&Promote

Configure one or more connections to Search&Promote so that your web pages can interact with the service. To connect, you need the member identification and account number of your Search&Promote account.

To configure the connection to Search&Promote:

  1. From the Tools icon > Deployment, select Cloud Services.

    This takes you to the Cloud Services Dashboard. If on a local machine, the url of the dashboard will look something like this:


  2. In the Cloud Services page, tap the Adobe Search&Promote link or the Search&Promote icon.

  3. If this is the first time you are configuring Adobe Search&Promote, tap Configure Now to open the Create Configuration panel.

    If you would like to learn more about Search&Promote click Learn more instead.


  4. Enter a Title that is recognizable to page authors, and enter a unique Name, then tap Create.

    Also, the newly created Configuration appears below Available Configurations on the Cloud Services dashboard Adobe Search&Promote list item.


  5. In the Edit Component dialog box, add the following to the fields:

    • Member ID
    • Account number

    In order to get this information yourself, log into the following:

    using your valid Seach&Promote credentials (email/password).

    Notice the URL in your brouser’s address bar. It should look something similar to the following:

    Where XXXXXXXX corresponds to your Member id and spYYYYYYYY corresponds to your account number.

  6. Tap Connect To Search&Promote.

    When the connection success message appears, tap OK.

    (After connecting, the button text changes to Re-Connect To Search&Promote.)

  7. Tap OK. The Search&Promote Settings page appears for the configuration that you have just created.

Configuring the Data Center

If your Search&Promote account is in Asia or Europe, you need to change the default data center so that it points to the right one (the default data center is for North American accounts).

To configure the data center:

  1. Navigate to the Web console at http://localhost:4502/system/console/configMgr/


  2. Depending on the location of the server, change the URI to one of the following:

  3. Tap Save.

Adding Search&Promote components to Sidekick

In Design mode, edit a par component to allow the Search&Promote components in Sidekick. (See the Components documentation for more information.)

For information about using the components, see Adding Search&Promote features to a Web Page.

Specifying the Search&Promote service that your pages use

Configure web pages so that they use a specific Search&Promote service. Search&Promote components automatically use the service of their host page.

When you configure the Search&Promote properties for a page, all child pages inherit the settings. If required, you can configure child pages to override the inherited settings.


The service connection must already be configured. See Configure the connection to Search&Promote.

  1. Open the Page Properties dialog box. For example, on the Websites page, right-click the page and click Properties.

  2. Click the Cloud Services tab.

  3. To disable the inheritance of cloud services configurations from a parent page, click the padlock icon next to the inheritance path.


  4. Click Add Service, select Adobe Search&Promote, then click OK.

  5. Select the connection configuration for your Search&Promote account, then click OK.

Product Feed

The Search&Promote integration lets you do the following:

  • Use the eCommerce API, independently of the underlying repository structure and commerce platform.
  • Leverage the Index Connector feature of Search&Promote to provide a product feed in XML format.
  • Leverage the Remote Control feature of Search&Promote to perform on-demand or scheduled requests of the product feed.
  • Feed generation for different Search&Promote accounts, configured as cloud services configurations.

For more information, see Product Feed.

On this page