Cross-Origin Requests
Overview
If your client and server are on different origins (e.g. making an API call to a server on api.foo.com
from JavaScript running on a client at foo.com
), the session token needs to be passed in a network request header. There are a few different ways this can be done on the front-end.
Using Fetch with React
In order to pass the session token using the browser Fetch API, it should be put inside a Bearer token in the Authorization header. To retrieve the session token, use the getToken()
method from the client package (e.g. @clerk/clerk-react
, @clerk/nextjs
). Be mindful that getToken
is an async function that returns a Promise which needs to be resolved.
1import { useAuth } from '@clerk/nextjs';23export default function useFetch() {4const { getToken } = useAuth();5const authenticatedFetch = async (...args) => {6return fetch(...args, {7headers: { Authorization: `Bearer ${await getToken()}` }8}).then(res => res.json());9};10return authenticatedFetch;11}
useSWR hook
If you are using React or Next.js and want to use the useSWR
hook, you can create a custom hook with useAuth
from Clerk. useAuth()
returns the asynchronous getToken
function that can be called to add the session token as a Bearer token in the Authorization header of requests.
1import useSWR from 'swr';2import { useAuth } from '@clerk/nextjs';34export default function useClerkSWR(url) {5const { getToken } = useAuth();6const fetcher = async (...args) => {7return fetch(...args, {8headers: { Authorization: `Bearer ${await getToken()}` }9}).then(res => res.json());10};11return useSWR(url, fetcher);12}
react-query
If you are using React Query, it will follow a similar pattern composing the useSession
hook.
1import { useQuery } from 'react-query';2import { useAuth } from '@clerk/nextjs';34export default function useClerkQuery(url) {5const { getToken } = useAuth();6return useQuery(url, async () => {7const res = await fetch(url, {8headers: { Authorization: `Bearer ${await getToken()}` }9});10if (!res.ok) {11throw new Error('Network response error')12}13return res.json()14});15}
Using Fetch with ClerkJS
If you are not using React or Next.js, you can access the getToken
method from the session
property of the Clerk
object. This assume you have already followed the instructions on setting up ClerkJS and provided it with your Frontend API URL.
1(async () => {2fetch('/api/foo', {3headers: {4Authorization: `Bearer ${await Clerk.session.getToken()}`5}6}).then(res => res.json());7})();
Conclusion
Using the above guides will make it possible to authenticate requests to the backend from a client and server that are on separate origins.
For information about other ways to authenticate requests, check out our guides on Same-Origin Requests and Backend Requests.