SDK Installation - Rise B2B API

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

Installation

NPM

npm install @riseworks/riseworks-sdk

Yarn

yarn add @riseworks/riseworks-sdk

PNPM

pnpm add @riseworks/riseworks-sdk

Quick Start

import { RiseApiClient } from '@riseworks/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:

Configuration - Configure the SDK for your environment
Skills - Copy Claude-style skills from @riseworks/riseworks-sdk into .claude/skills/
Authentication Guide - Set up authentication methods
API Reference - Complete API documentation

Authentication SDK Configuration

⌘I

​Installation

​NPM

​Yarn

​PNPM

​Quick Start

​Common Issues

Import Errors

Authentication

Network Issues

Type Errors

​Getting Help

​Next Steps

Installation

NPM

Yarn

PNPM

Quick Start

Common Issues

Getting Help

Next Steps