Function ensureAuthenticatedAppManagementAndBusinessPlatform

  • ensureAuthenticatedAppManagementAndBusinessPlatform(
        options?: EnsureAuthenticatedAdditionalOptions,
        appManagementScopes?: "https://api.shopify.com/auth/organization.apps.manage"[],
        businessPlatformScopes?: "destinations"[],
        env?: ProcessEnv,
    ): Promise<
        {
            appManagementToken: string;
            businessPlatformToken: string;
            userId: string;
        },
    >

  • Ensure that we have a valid session to access the App Management API.

    Parameters

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

    • appManagementScopes: "https://api.shopify.com/auth/organization.apps.manage"[] = []

      Optional array of extra scopes to authenticate with.

    • businessPlatformScopes: "destinations"[] = []

      Optional array of extra scopes to authenticate with.

    • env: ProcessEnv = process.env

      Optional environment variables to use.

    Returns Promise<
        {
            appManagementToken: string;
            businessPlatformToken: string;
            userId: string;
        },
    >

    The access token for the App Management API.

Settings

Member Visibility