API Reference

Complete reference documentation for all Endora API endpoints, including request/response formats, authentication, and examples.

What You'll Find Here

• Complete endpoint documentation
• Request/response examples
• Authentication methods
• Error handling
• Rate limiting information
• Interactive testing interface

API Reference Overview

Learn how to navigate and use the comprehensive API reference documentation.

Base URL

All API endpoints use the following base URL:

https://api.endora.space/v1/{project-id}

Replace {project-id} with your actual project identifier.

CRUD Operations

GET - Retrieve Data

# Get all records
GET /{table-name}

# Get single record
GET /{table-name}/{id}

# Get with filters
GET /{table-name}?filter=value&limit=10&offset=0

POST - Create Data

# Create new record
POST /{table-name}
Content-Type: application/json

{
  "field1": "value1",
  "field2": "value2"
}

PUT - Update Data

# Update record
PUT /{table-name}/{id}
Content-Type: application/json

{
  "field1": "new_value1",
  "field2": "new_value2"
}

DELETE - Remove Data

# Delete record
DELETE /{table-name}/{id}

Endpoint Testing Demo

See how to perform Create, Read, Update, and Delete operations with your API.

Response Formats

Success Response

{
  "success": true,
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "message": "Record retrieved successfully"
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input data",
    "details": {
      "email": "Invalid email format"
    }
  }
}

Error Handling

Common Error Codes

Code	Description	Solution
400	Bad Request	Check request format and parameters
401	Unauthorized	Verify API key and authentication
403	Forbidden	Check permissions and access rights
404	Not Found	Verify endpoint URL and resource ID
429	Rate Limited	Wait before making more requests
500	Server Error	Contact support if persistent

Error Handling Best Practices

// Example error handling
try {
  const response = await fetch('/api/users/1');
  if (!response.ok) {
    const error = await response.json();
    console.error('API Error:', error.message);
    // Handle specific error cases
    if (error.code === 'VALIDATION_ERROR') {
      // Handle validation errors
    }
  }
} catch (error) {
  console.error('Network Error:', error);
}

Interactive Testing

Swagger UI

Access the interactive API documentation:

1. Navigate to API Docs: Go to your project's API documentation
2. Authenticate: Register and Login to get access token and pass it in authorized interface.
3. Test Endpoints: Use the interactive interface
4. View Responses: See real-time responses