You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
MiddlewareApiConfig
Settings for requests sent to OCC API.
export interface MiddlewareApiConfig {
apiProvider?: ApiProvider;
asmApiProvider?: ApiProvider;
asmUri?: string;
baseSiteId: string;
baseStoreUid?: string;
catalogId: string;
catalogVersion: string;
defaultCurrency: string;
defaultLanguage: string;
uri: string;
urlPatterns?: string[];
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
apiProvider | Optional | ApiProvider | API provider class for the main API. |
asmApiProvider | Optional | ApiProvider | API provider class for the Assisted Service Module API. |
asmUri | Optional | string | Full Assisted Service Module API uri (e.g. https://<your-sap-api>/assistedservicewebservices/). You can omit this if you don't use ASM features |
baseSiteId | Required | string | First parameter of every request (e.g. electronics). It allows for fetching content for the right Base Site and - in turn - the right Base Store. |
baseStoreUid | Optional | string | Unique identifier of the Base Store. Can be skipped if the uid of your Base Store and the uid of your Base Site are the same. |
catalogId | Required | string | Main catalog id (e.g. electronicsProductCatalog). |
catalogVersion | Required | string | Main catalog version (e.g. Online). |
defaultCurrency | Required | string | Isocode of the default currency for the current Base Store (e.g. USD). Will be sent to OCC API if no vsf-currency cookie comes from the frontend (e.g. during the first page load). |
defaultLanguage | Required | string | Isocode of the default language for the current Base Store (e.g. EN). Will be sent to OCC API if no vsf-locale cookie comes from the frontend (e.g. during the first page load). |
uri | Required | string | Full OCC API uri (e.g. https://<your-sap-api>/occ/v2/). |
urlPatterns | Optional | string[] | Array of URL patterns that can be used for domain recognition. |