headless-js-api

Version:

Headless JS client for Ecwid public API

17 lines (15 loc) • 722 B

TypeScript

/**
 * Configuration object for initializing the API client.
 *
 * @property {string} publicToken - The public access token for your store's API.
 * This token is used to authenticate requests that do not require a private token, such as fetching product or category data.
 * @property {string} [baseURL] - The base URL for the Ecwid API.
 * Default to 'https://app.ecwid.com/api/v3/'. This can be overridden for testing or specific regional API endpoints.
 * @property {string} [storeId] - The unique identifier for your Ecwid store. This ID is used to specify which store's data to access.
 */
interface ApiConfig {
    publicToken: string;
    storeId?: number;
    baseURL?: string;
}

export type { ApiConfig as A };