Contentful Personalization & Analytics
    Preparing search index...

    Interface ApiConfig

    Configuration options for API clients extending ApiClientBase.

    interface ApiConfig {
        baseUrl?: string;
        clientId: string;
        environment?: string;
        fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseUrl? clientId environment? fetchOptions?

    Properties

    baseUrl?: string

    Base URL for the API.

    When omitted, the concrete client is expected to construct full URLs internally.

    clientId: string

    Client identifier used for authentication or tracking.

    environment?: string

    Contentful environment identifier.

    Defaults to main when not provided.

    fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">

    Options used to configure the underlying protected fetch method.

    apiName is derived from the client name and must not be provided here.

    Settings

    Member Visibility

    On This Page

    Properties