Skip to main content
The Rise SDK provides a comprehensive TypeScript/JavaScript client for integrating with Rise B2B API.

​
Installation

​
NPM

npm install @riseworks/sdk

​
Yarn

yarn add @riseworks/sdk

​
PNPM

pnpm add @riseworks/sdk

​
Quick Start

import { RiseApiClient } from '@riseworks/sdk';

// Initialize with JWT authentication
const client = new RiseApiClient({
  environment: 'prod',
  jwtToken: process.env.JWT_TOKEN
});

// Make your first API call
const user = await client.me.get();
console.log('User:', user);

​
Common Issues

Import Errors

  • Check peer dependencies
  • Verify TypeScript configuration
  • Ensure correct import syntax

Authentication

  • Verify environment variables
  • Check token expiration
  • Validate private key format

Network Issues

  • Check internet connection
  • Verify API endpoints
  • Review firewall settings

Type Errors

  • Update TypeScript version
  • Check type definitions
  • Verify SDK version

​
Getting Help

  • Documentation: Check this documentation for detailed guides
  • GitHub Issues: Report bugs and request features
  • Support: Contact support for enterprise assistance
  • Community: Join our Discord for community help

​
Next Steps

After installation, proceed to:
⌘I