Api Overview

Our API follows a standardized JSON request/response format designed for consistency, readability, and ease of integration.

Request Structure

• All requests use JSON format.
• Required fields must be explicitly defined.
• Headers should include authentication tokens when applicable.

Response Structure

Every API response follows a structured format:

{
  "status": "success|error",
  "message": "Description of the response",
  "data": { ... } // Optional, contains response data when successful
}

Error Handling

• Standardized error codes to ensure clarity.
• Meaningful error messages for easy debugging.
• HTTP status codes align with RESTful principles (e.g., 200, 400, 401, 500).