Interface ClientConfig

HTTP client configuration options.

interface ClientConfig {
    accessToken?: string;
    apiKey?: string;
    apiSecret?: string;
    apiVersion?: string;
    baseURL: string;
    headers?: Record<string, string>;
    timeout?: number;
}

Properties

accessToken? apiKey? apiSecret? apiVersion? baseURL headers? timeout?

Properties

Optional accessToken

accessToken?: string

Access token for authentication. Set automatically after successful OAuth flow.

Optional apiKey

apiKey?: string

API Key for private app authentication

Optional apiSecret

apiSecret?: string

API Secret for private app authentication

Optional apiVersion

apiVersion?: string

API version (optional). Defaults to the latest stable version.

baseURL

baseURL: string

Base URL for API requests (e.g., 'https://your-store.mysapo.net').

Optional headers

headers?: Record<string, string>

Additional headers to include in requests.

Optional timeout

timeout?: number

Request timeout in milliseconds. Defaults to 30000 (30 seconds).

Settings

Member Visibility

Theme

On This Page

accessTokenapiKeyapiSecretapiVersionbaseURLheaderstimeout