Backend Integration

Example

NodeJS

An example implementation can be found here.

GoLang

Examples can be found here

Python

Examples can be found here

1) Install

NodeJS

npm i -s supertokens-node

GoLang

go get github.com/supertokens/supertokens-golang

Python

pip install supertokens-python

2) Initialise SuperTokens

Please fill the form below to see the code snippet (* = Required)

To learn more about what these properties mean read here.

Your app's name:*

This is the name of your application

API Domain:*

This is the URL of your app's API server.

API Base Path:

SuperTokens will expose it's APIs scoped by this base API path.

Website Domain:*

This is the URL of your website.

Website Base Path:

SuperTokens UI will be shown on this website route.

Submit form

3) Initialise Social login providers

Please fill the form below to see the code snippet (* = Required)

To learn more about what these properties mean read here.

API Domain:*

This is the URL of your app's API server.

API Base Path:

SuperTokens will expose it's APIs scoped by this base API path.

Website Domain:*

This is the URL of your website.

Website Base Path:

SuperTokens UI will be shown on this website route.

Submit form

4) Add the SuperTokens APIs & CORS setup

Please fill the form below to see the code snippet (* = Required)

To learn more about what these properties mean read here.

API Base Path:

SuperTokens will expose it's APIs scoped by this base API path.

Website Domain:*

This is the URL of your website.

Submit form

5) Add the SuperTokens error handler

Add the errorHandler AFTER all your routes, but BEFORE your error handler

NodeJS

Express

info

Please refer the Serverless Deployment section (Towards the bottom of the navigation index)

Hapi

info

Please refer the NextJS section (Towards the bottom of the navigation index)

Fastify

info

Please refer the NestJS section (Towards the bottom of the navigation index)

Koa

import express, { Request, Response, NextFunction } from "express";import { errorHandler } from "supertokens-node/framework/express";
let app = express();// ...your API routes
// Add this AFTER all your routesapp.use(errorHandler())
// your own error handlerapp.use((err: unknown, req: Request, res: Response, next: NextFunction) => { /* ... */ });

Loopback

No additional errorHandler is required.

Serverless

Add the errorHandler Before all your routes and plugin registration

import Fastify from "fastify";import { errorHandler } from "supertokens-node/framework/fastify";
let fastify = Fastify();
fastify.setErrorHandler(errorHandler());
// ...your API routes

Next.js

No additional errorHandler is required.

Nest.js

No additional errorHandler is required.

GoLang

info

You can skip this step

Python

info

You can skip this step

6) Test if sign up is setup correctly

• Visit the login form on the website.
• Try to sign up.
• If after signing up, you are redirected to /, everything is setup correctly 😁
• If not, you can always ask for help via Github issues or via our Discord

7) Setup the SuperTokens core

Are you using https://try.supertokens.com as the connection URI in the init function?

YesNo