Quickstart Guide
Welcome to the Rayda API documentation. This guide will walk you through the initial steps needed to integrate our API and unlock its full potential in your application.Overview
The Rayda API provides comprehensive access to the features available on the Rayda dashboard. Designed with RESTful principles, it allows you to extend platform functionality within your own applications. Most core resources are directly accessible, with a few specialized endpoints offering additional capabilities.Prerequisites
Before getting started, ensure you have:- API Access: Access to our API is exclusive to accounts on the Premium and Enterprise plans.
- API Keys: Obtain your API key from the API Keys Dashboard.
- Staging and Production Environments:
- Use your Staging API Key for testing in the staging environment.
- Only the Production API Key is valid for live environments.
Note: Staging keys are restricted to staging environments to prevent unintended transactions in production.
Requests and Responses
All requests to the Rayda API should include body data formatted as JSON, and response data will also be returned in JSON format. TheContent-Type for responses is always application/json. Responses generally follow a standard structure as outlined below:
Response Keys
| Key | Type | Description |
|---|---|---|
| success | Boolean | Indicates if the request was successful. Use this in combination with the HTTP status code to determine the result. |
| message | String | A brief description of the result. For example, "Record created successfully" indicates successful creation. "Record fetched successfully" indicates successful retrieval. In error cases, it describes the issue. |
| data | Object | Contains the result of the request. The content depends on the type of request — it could be an object or an array of objects. |