Shopify API authentication

You can use Shopify CLI to generate a starter app with boilerplate code that handles authentication and authorization. The starter app includes code for an embedded app that follows app best practices:

• Authorizing your app using session tokens and token exchange.
• Installing on stores using Shopify managed installation.

You should use this starter app unless you need to scaffold an app that is not embedded.

Scaffold an app

Scaffold an app that follows all authentication and authorization best practices.

To learn more about the authentication and authorization methods that you can use for Shopify apps, and the libraries that you can use to simplify your implementation, refer to authentication and authorization.

All Storefront API requests require a valid Shopify access token. The following types of tokens are available:

• Public access tokens: Used to make requests from client-side applications, such as a browser or mobile app.

• Private access tokens: Used to make requests from a server or other private context.

Apps can have a maximum of 100 active storefront access tokens per shop.

Public access tokens enable your app to make Storefront API requests from public contexts like a browser. With public access, capacity scales with the number of buyers based on customer IP. In most cases, this is the IP of someone browsing your site or using your mobile app. Learn more about Storefront API rate limits.

To use public access, you need to create a public access token for your app by making a request to the GraphQL Admin API's storefrontAccessTokenCreate mutation. Alternatively, you can create a custom app in the Shopify admin, and retrieve your Storefront API access token and manage access scopes from there.

To query the Storefront API with a public access token, include it as an X-Shopify-Storefront-Access-Token header on all client-side requests.

Private access tokens let you make authenticated, server-side queries to the Storefront API.

To start using private access, you can use the following methods:

• Add the Headless channel to your Shopify admin.

• Create a delegate access token for your custom app.

• Request unauthenticated scopes on an existing access token.

To query the Storefront API with a private access token:

1. Include the Shopify-Storefront-Private-Token header with the private access token.

In some cases, a request to the Storefront API isn't linked to buyer traffic, such as during a static site build, however when making server-side requests to the Storefront API as a result of buyer traffic, be sure to also:

1. Include the Shopify-Storefront-Buyer-IP (case-sensitive) header with the IP address of the buyer. This allows Shopify to accurately enforce IP-level bot and platform protection, to help your storefront manage traffic from a single user consuming a high level of capacity, such as a bot.

• Authenticate your embedded app using session tokens.
• Authorize your embedded app using a session token with token exchange.
• Authorize your app that is not embedded with authorization code grant.
• Authenticate your app created in the Shopify admin with access tokens.