About session tokens
A session token is a mechanism that lets your embedded app authenticate the requests that it makes between the client side and your app's backend.
All embedded apps need to use session tokens because third-party cookies won't work with browsers that restrict cross-domain data access. If your embedded app still uses cookies and could pose a risk to users, then as part of our app audit process you might be contacted and requested to migrate your app to use session tokens. This request will require immediate action.
The following video provides a short introduction to session tokens:
Anchor to How session tokens workHow session tokens work
This section describes the authentication and request flows associated with session tokens, and the lifetime of a session token. It also provides information about implementing both OAuth and session token authentication for embedded apps.
Anchor to Authentication flow using a session tokenAuthentication flow using a session token
When your embedded app first loads, it's unauthenticated and serves up the frontend code for your app. Your app renders a user interface skeleton or loading screen to the user.
After the frontend code has loaded, your app calls a Shopify App Bridge action to get the session token. Your app includes the session token in an authorization header when it makes any HTTPS requests to its backend.
Anchor to Request flow using a session tokenRequest flow using a session token
The session token is signed using the shared secret between your app and Shopify so that your backend can verify if the request is valid.
Anchor to Lifetime of a session tokenLifetime of a session token
The lifetime of a session token is one minute. Session tokens must be fetched using Shopify App Bridge on each request to make sure that stale tokens aren't used.
Anchor to OAuth and session tokensOAuth and session tokens
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 uses session tokens and token exchange.
Session tokens are for authentication, and aren't a replacement for authorization. Learn more about the difference between authentication and authorization.
Unlike API access tokens, session tokens can't be used to make authenticated requests to Shopify APIs. An API access token is what you use to send requests from your app's backend to Shopify so that you can fetch specific data from the user's shop.
For example, to make authenticated requests to the GraphQL Admin API, your app must store the access token it receives during the OAuth flow. To contrast, session tokens are used by your app's backend to verify the embedded request coming from your app's frontend.
The following diagram shows the authentication process using session tokens and API access tokens:
Anchor to Anatomy of a session tokenAnatomy of a session token
Session tokens use the JSON Web Token (JWT) format and contain information about the merchant that's currently using your embedded app.
A session token consists of a header, payload, and signature. For an interactive example, refer to JWT.io, where you can experiment with setting different values for each section. Shopify recommends that you use your test app's credentials when testing on JWT.io.
For the most part, you shouldn't have to manage the anatomical details of session tokens. In most scenarios, you'll use a library, such as authenticated_fetch from app-bridge, which generates and includes the session token in your requests. On the backend, you can use middleware similar to validateAuthenticatedSession in @shopify/shopify-app-express.
After a Shopify session token is decoded, it has the following fields:
Anchor to HeaderHeader
The values in the header are constant and never change.
alg: The algorithm used to encode the JWT.typ: The (type) header parameter used by session token to declare the media type.
Anchor to PayloadPayload
iss: The shop's admin domain.dest: The shop's domain.aud: The client ID of the receiving app.sub: The User that the session token is intended for.exp: When the session token expires.nbf: When the session token activates.iat: When the session token was issued.jti: A secure random UUID.sid: A unique session ID per user and app.sig: Shopify signature.
Anchor to Example payloadExample payload
All times are in UNIX timestamp format.
Anchor to Limitations and considerationsLimitations and considerations
Session token authentication is fully supported for single-page apps. For more information, refer to Getting started with session token authentication.
If you have a multi-page app, then it might be possible to convert it to behave as if it were a single-page app using Turbolinks. You can only use session tokens for a multi-page app if you convert it to behave like a single-page app. For an example, refer to the Turbolinks and JWT sample app.
In some cases, ad blockers can interfere with session tokens. If you're submitting your app to the Shopify App Store and the automated check for session tokens is hanging, then try disabling your ad blocker and interacting with your app to record the required session data.
Anchor to Sample appsSample apps
- Sample single-page embedded app using Rails and React
- Sample server-side rendered Rails app converted using Turbolinks
Anchor to Next stepsNext steps
- Set up your embedded app to authenticate using session tokens.