Installation

Install the Proma SDK and obtain your OAuth credentials.

Install the package

npm install @proma/sdk
# or
pnpm add @proma/sdk
# or
yarn add @proma/sdk

Obtain credentials

Sign in to Proma and open the Developer Portal.
Click New App and fill in a name and redirect URI.
Copy your Client ID — you will need it to initialise the SDK.

The redirect URI must exactly match what you pass to PromaClient. For local development, http://localhost:3000/auth/callback is a common choice.

Browser requirements

The SDK requires crypto.subtle (SubtleCrypto) for PKCE. This is available in all modern browsers and in Node 18+. If you are targeting older environments, polyfill globalThis.crypto.

Next steps

Quick Start — log in a user in four steps
PromaClient — full API reference