Getting started with Search

Important

The Search API is currently in Early Availability status. For more information, see Product lifecycle phases.

Getting started with Search

For a description of the AppDirect Search feature, see Search.

Search, and this Quick Start guide, supports the following use case.

A merchant, who is also the vendor:

• sells customers one or more products

• publishes data from one or more sources to AppDirect Search

• uses the search API to allow users to do keyword searches on the aggregated data, and view the results, on the merchants' platforms

• uses the feeds API to query the aggregated data, retrieve current information with most recently updated first to populate feeds, and provide users with filters to narrow the feed contents, on the merchant's platforms

Set up and use search and feeds

1. Configure products: To aggregate data related to a product, enable the Search integration settings for it. See Configure products for Search.

2. Connect a user and product: To aggregate and search data related to a user and their app account, associate the user, product, and Search. See Connect users and applications to Search.

3. Publish content: Publish user data related to a product to Search. See Publish data to Search.

4. Do one or both of the following:

   • Search content: Search for keywords in the aggregated data that are visible to a connected user and product. See Search content.

   • Query content for feeds: Retrieve the resources that have been most recently updated and their associated attributes, and are visible to a connected user and product. See Query feed resources (GraphQL API).

5. Disconnect a user and product: When the subscription ends, disconnect the user and app account from Search. See Disconnect users and applications from Search.