Overview
Once your RB2B APIs account is created, you can immediately access your dashboard, locate your API key, and explore full technical documentation for every available endpoint.
This guide walks you through the essential first steps to begin integrating with RB2B APIs.
Step 1: Locate Your API Key
Your API key is what authenticates your requests to RB2B APIs.
To find it:
From the dashboard sidebar, click API Dashboard.
Locate your API key under API Key at the top right.
Click Copy to securely copy it to your clipboard.
Keep your API key private. Do not share it publicly or embed it in client-side code.
Your key uniquely identifies your company account and tracks credit usage.
Step 2: Activate APIs
Each RB2B API is disabled by default when your account is created.
You’ll need to activate any API you plan to use before sending requests to it.
To activate an API:
In your API Dashboard, find the API you want to enable.
Use the toggle switch at the top right of the API card to turn it ON.
Once enabled, that API becomes active and ready to receive requests from your integrations.
💡 Note: Activating an API does not consume credits.
Credits are only deducted when you make a live, successful API request.
Step 3: Review API Documentation
Each RB2B API endpoint has a dedicated documentation page on Postman with full technical details, including:
Request and response formats
Supported parameters
Example payloads
Error codes and response handling
To view technical endpoint documentation, visit the RB2B APIs Postman Collection.
Step 4: Make Your First API Request
Once you’ve located your API key and reviewed the documentation, you’re ready to make your first authenticated request.
Each RB2B API request must include the following in the request headers:
Key | Value |
API-Key | {{api_key}} |
Content-Type | application/json |
For endpoint URLs, request body formatting, and examples of Successful Responses, Empty Responses, and Malformed Requests view technical endpoint documentation, visit the RB2B APIs Postman Collection.
Step 5: Monitor Credit Usage
You can view your remaining credits and usage by endpoint directly in your dashboard.
From the left-hand menu, select API Dashboard to:
Check your current credit balance
Review historical usage
💡 Credit usage updates in real time. If your credits reach zero, new API requests will be rejected until you purchase more.