Alokai

DiscoveryApiConfig

Discovery API configuration for new generated APIs.

interface DiscoveryApiConfig {
	accountId: number;
	authKey?: string;
	autosuggest?: SubApiConfig;
	bestseller?: SubApiConfig;
	contentSearch?: SubApiConfig;
	domainKey: string;
	emailWidget?: SubApiConfig;
	recommendationsPathways?: SubApiConfig;
	search?: SearchApiConfig;
}

Properties

NameRequiredTypeDescription
accountIdRequirednumberYour site's numerical Bloomreach account ID.
authKeyOptionalstringAuthentication key for the Bloomreach account.
autosuggestOptionalSubApiConfigConfiguration for the Autosuggest API. Resolved default basePath: https://suggest.dxpapi.com/api/v2/suggest
bestsellerOptionalSubApiConfigConfiguration for the Bestseller API. Resolved default basePath: https://core.dxpapi.com/api/v1/core
contentSearchOptionalSubApiConfigConfiguration for the Content Search API. Resolved default basePath: https://core.dxpapi.com/api/v1/core
domainKeyRequiredstringYour site domain's key, provided by Bloomreach.
emailWidgetOptionalSubApiConfigConfiguration for the Email Widget API. Resolved default basePath: https://pathways-email.dxpapi.com
recommendationsPathwaysOptionalSubApiConfigConfiguration for the Recommendations & Pathways API. Resolved default basePath: https://pathways.dxpapi.com/api/v2/widgets
searchOptionalSearchApiConfigConfiguration specific to the Product Search / Category API. Resolved default basePath: https://core.dxpapi.com/api/v1/core

Referenced Types

On this page