Working with the Radaro API Documentation
Each page of the Radaro API documentation is organized into three main panels
From left to right:
1. Navigation Panel (Left Panel)
This section allows you to explore the two primary areas of the documentation:
- API Reference: Lists all available API endpoints grouped by function (e.g., Jobs, Drivers, etc.)
- Webhooks: Describes events Radaro can send to your system in real time
Each folder expands into sub-items that either contains:
- A Request Builder (an interactive form to test the endpoint)
- Or a text-based explanation with payload examples and usage guidance
2. API Request Form / Explanation Panel (Middle Panel)
When an endpoint or webhook is selected, this central panel displays either a description or an interactive API request form, broken down into:
- Path Parameters: Required elements in the URL (e.g., external_id)
- Query Parameters: Optional filters or flags appended to the URL
- Body Parameters: JSON payload fields sent with POST/PATCH requests
Each parameter includes:
- The field name
- The field type
- A description
- Example values (or nested expandables for objects and arrays)
Below the form, you can expand the Response Body section to preview the expected response structure for successful calls.
3. Code Console / Output Panel (Right Panel)
This right-hand panel helps you visualize and test API calls.
- Language Selector: Choose your preferred language (e.g., cURL, Python, Node.js)
- Credentials: Enter your API Key to be put in the header to send live requests
- "EXAMPLES" Button: Click this to auto-populate the request form and code console with a valid sample payload
- Example Responses: Below the console, view real response samples based on their response codes
You can edit and re-run requests directly from this panel to explore variations and debug integrations.