Choose a version:

Session Token
API

The API for interacting with session tokens.

Anchor to standardapiStandardApi

The base API object provided to purchase extension targets.

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.

Was this section helpful?

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.

Was this section helpful?

Using a session token with fetch()

import {useEffect} from 'react';

import {

reactExtension,

Banner,

useApi,

} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(

'purchase.checkout.block.render',

() => <Extension />,

);

function Extension() {

const {sessionToken} = useApi();

useEffect(() => {

async function queryApi() {

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

const token = await 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 (

<Banner>See console for API response</Banner>

);

}

Anchor to examplesExamples

Session token claims

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 for details.

Was this section helpful?