Set Up Access

Accept your Dashboard invite, get your API keys, choose the SDK or REST, and authenticate your requests to Rain.

Before you build, you need access to the Rain Dashboard and a way to authenticate your API requests. This guide walks you through accepting your invite, finding your API keys, choosing between the SDK and the REST API, and authenticating your first call.

Rain gives you two separate environments. Sandbox is a test environment with no real money: you can issue test cards, simulate transactions, and try your webhooks without affecting production. Production is your live program, with real cardholders and real funds.

Use the sandbox to build and test your integration, then switch to production when you go live. Each environment has its own Rain Dashboard, where you manage your API keys and webhooks and view the users, companies, cards, transactions, and disputes in your program.

Before you begin

Identify your program type and management model, since they shape which guides and API references apply to your build.

1. Accept your Dashboard invite

   Your access depends on the environment:

   • Sandbox: Rain creates a sandbox account for you and sends an email invite from the implementation team. Accept it to reach your Sandbox Developer Dashboard.
   • Production: When you’re ready to go live, Rain sets up your production account and sends you an invite, the same way as sandbox. Accept it to reach your Production Developer Dashboard.

   If you can’t see the Issuing page after accepting your invite, contact your Implementation Manager.

2. Get your API keys

   Open the Config page in the Dashboard to retrieve your API key and secret:

   • Sandbox Config page
   • Production Config page

   You use these keys to authenticate every API request. A new key defaults to the admin role, which has full access. To create keys with narrower access, rotate keys, or restrict a key to specific IP addresses, see Authenticating with the API.

3. Choose the SDK or REST

   Decide how you want to call the API:

   • SDK: The Rain SDK is available for TypeScript and Python and gives you type safety, IDE autocomplete, and a consistent interface. See the SDK overview to install it and make your first call. Some newer endpoints aren’t in the SDK yet. For those, call the REST API directly.
   • REST: The SDK is optional. You can make the same calls directly to the Rain REST API using any HTTP client.

   Install the SDK if you want to use it:

   TypeScript

   npm install @rainapi/rain-sdk
   
4. Authenticate your requests

   Include your API key in the Api-Key header on every request:

   curl -X GET "https://api.rain.xyz/v1/example" \
        -H "Api-Key: YOUR_API_KEY"
   

   With the SDK, pass your API key when you initialize the client and choose your environment:

   TypeScript

   import Rain from '@rainapi/rain-sdk';
   
   const client = new Rain({
     apiKey: process.env['RAIN_API_KEY'],
     environment: 'dev', // use 'production' for live
   });
   

   Never expose API keys in client-side code such as JavaScript or mobile apps. Always use HTTPS so no one can intercept your keys.

What’s next

Connect webhooks

Set your webhook URL and verify signatures so you catch events from your first call.

Onboard a cardholder

Submit a KYC or KYB application and confirm approval.

Authenticating with the API

See API key roles, rotation, and IP restrictions in full.