Interactive API Documentation¶

Quick Start¶

1. Obtain an access token: Call /auth/register or /auth/login
2. Authorize: Click the "Authorize" button below and paste your token
3. Try endpoints: Click "Try it out" on any endpoint to test it

Authentication¶

Most endpoints require a JWT Bearer token. Include it in the Authorization header:

Authorization: Bearer <your_access_token>

Swagger UI¶

Need Help?¶

• Authentication Guide - Detailed auth flow documentation
• Two-Factor Auth Guide - 2FA setup and verification
• Integration Examples - Code examples for common scenarios
• Error Codes - Complete error reference

Rate Limiting¶

All API endpoints are rate-limited to prevent abuse:

Exceeding the rate limit returns HTTP 429 (Too Many Requests).

Response Format¶

All responses follow this format:

Success Response¶

{
  "success": true,
  "data": {
    // Response data here
  }
}

Error Response¶

{
  "success": false,
  "error": "Error message here"
}

Common HTTP Status Codes¶