Choose a version:

Session Token

The API for interacting with session tokens.

Anchor to standardapiStandardApi

The base API object provided to purchase extension targets.

Anchor to sessionToken sessionToken required: The session token providing a set of claims as a signed JSON Web Token (JWT).

The token has a TTL of 5 minutes.

If the previous token expires, this value will reflect a new session token with a new signature and expiry.

Refer to session token examples for more information.

SessionToken

get
Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself.
```
() => Promise<string>
```

Anchor to useSessionToken
useSessionToken()

Returns a the session token API object.

Anchor to useSessionToken-returnsReturns

SessionToken

get () => Promise<string>: Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself.

SessionToken

get
Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method will return cached tokens when possible, so you don’t need to worry about storing these tokens yourself.
```
() => Promise<string>
```

Examples

Preact

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

import {useEffect} from 'preact/hooks';

export default function extension() {

render(<Extension />, document.body);

}

function Extension() {

const {sessionToken} = shopify;

useEffect(() => {

async function queryApi() {

// Request a new (or cached) session token from Shopify

const token =

await shopify.sessionToken.get();

console.log('sessionToken.get()', token);

const apiResponse =

await fetchWithToken(token);

// Use your response

console.log('API response', apiResponse);

}

function fetchWithToken(token) {

const result = fetch(

'https://myapp.com/api/session-token',

{

headers: {

Authorization: `Bearer ${token}`,

},

);

return result;

}

queryApi();

}, [sessionToken]);

return (

<s-banner>

See console for API response

</s-banner>

);

}

Examples

Using a session token with fetch()

Description

You can request a session token from Shopify to use on your application server. The contents of the token claims are signed using your shared app secret so you can trust the claims came from Shopify unaltered. > Note: You will need to [enable the `network_access` capability](/docs/api/checkout-ui-extensions/configuration#network-access) to use `fetch()`.

Preact

import '@shopify/ui-extensions/preact';
import {render} from 'preact';
import {useEffect} from 'preact/hooks';

export default function extension() {
  render(<Extension />, document.body);
}

function Extension() {
  const {sessionToken} = shopify;

  useEffect(() => {
    async function queryApi() {
      // Request a new (or cached) session token from Shopify
      const token =
        await shopify.sessionToken.get();
      console.log('sessionToken.get()', token);

      const apiResponse =
        await fetchWithToken(token);
      // Use your response
      console.log('API response', apiResponse);
    }

    function fetchWithToken(token) {
      const result = fetch(
        'https://myapp.com/api/session-token',
        {
          headers: {
            Authorization: `Bearer ${token}`,
          },
        },
      );
      return result;
    }

    queryApi();
  }, [sessionToken]);

  return (
    <s-banner>
      See console for API response
    </s-banner>
  );
}

Session token claims
Description
The contents of the token are signed using your shared app secret. The optional `sub` claim contains the customer's `gid` if they are logged in and your app has permission to read customer accounts. For example, a loyalty app that needs to check a customer's point balance can use the `sub` claim to verify the customer's account. > Caution: > Your app server can only trust the claims within the session token. It cannot use the token to trust the entire HTTP request. See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) for details.
session-token.jwt
```
{
  // Shopify URL
  "dest": "store-name.myshopify.com",
  // The Client ID of your app
  "aud": "<clientId>",
  // When the token expires.  Set at 5 minutes.
  "exp": 1679954053,
  // When the token was actived
  "nbf": 1679953753,
  // When the token was issued
  "iat": 1679953753,
  // A unique identifier (a nonce) to prevent replay attacks
  "jti": "6c992878-dbaf-48d1-bb9d-6d9b59814fd1",
  // Optional claim present when a customer is logged in and your app has permissions to read customer data
  "sub": "gid://shopify/Customer/<customerId>"
}
```