Home > widget-integration > InstantSearchAPI > buildApiUrl

InstantSearchAPI.buildApiUrl() method

Build API URL for external Boost search service.

NOTE: The locale is passed as a query parameter (&locale=en) via addCurrencyParams() / addLocalizationParams()

Signature:

protected buildApiUrl(endpoint: string): string;

Parameters

Parameter

Type

Description

endpoint

string

API endpoint (e.g. '/suggest', '/products', '/redirects')

Returns:

string

Full API URL