Skip to content

SDKs

Official SDKs provide OAuth helpers and typed API clients:

LanguagePackage
Node.js@makeplane/plane-node-sdk
Pythonplane-sdk
bash
npm install @makeplane/plane-node-sdk
# or
pip install plane-sdk

OAuth helper methods

typescript
import { OAuthClient } from "@makeplane/plane-node-sdk";

const oauth = new OAuthClient({
  clientId: "your_client_id",
  clientSecret: "your_client_secret",
  redirectUri: "https://your-app.com/callback",
});

// Generate authorization URL
const authUrl = oauth.getAuthorizationUrl("code", "state");

// Exchange for bot token
const token = await oauth.getBotToken(appInstallationId);

// Exchange code for user token
const userToken = await oauth.exchangeCodeForToken(code);

// Refresh user token
const newToken = await oauth.getRefreshToken(refreshToken);
python
from plane.client import OAuthClient

oauth = OAuthClient(
    client_id="your_client_id",
    client_secret="your_client_secret",
)

# Generate authorization URL
auth_url = oauth.get_authorization_url(redirect_uri="...", state="state")

# Exchange for bot token
token = oauth.get_client_credentials_token(app_installation_id=app_installation_id)

# Exchange code for user token
user_token = oauth.exchange_code(code=code, redirect_uri=redirect_uri)

# Refresh user token
new_token = oauth.refresh_token(refresh_token)