Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.eazemyapi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
EazeMyAPI URL Structure

All EazeMyAPI endpoints follow a consistent URL structure. 
https://api.eazemyapi.com/{project}/{table}/{version}/{action}
Each part of the URL defines how the API request is routed.

​
URL Components

ComponentDescription
api.eazemyapi.comBase API server
{project}Your project identifier
{table}Database table name
{version}API version (v1, v2, etc.)
{action}CRUD operation (list, create, update, delete)

​
Example API URL

https://api.eazemyapi.com/demo-project/users/v1/list
In this example:
PartValue
projectdemo-project
tableusers
versionv1
actionlist

​
CRUD API Structure

EazeMyAPI automatically generates standard CRUD APIs for every table.
OperationMethodEndpoint
List RecordsGET/{project}/{table}/{version}/list
Create RecordPOST/{project}/{table}/{version}/create
Update RecordPOST/{project}/{table}/{version}/update/{id}
Delete RecordDELETE/{project}/{table}/{version}/delete/{id}

​
API Request Example

​
cURL Example

curl "https://api.eazemyapi.com/demo-project/users/v1/list" \
  -H "X-API-SIGNATURE: your-secret-key"

​
Example Response

{
  "success": true,
  "message": "Data found.",
  "data": [
    {
      "id": 1,
      "name": "Dara Singh",
      "email": "dara@eazemyapi.com"
    }
  ]
}

​
API Versioning

EazeMyAPI uses versioned APIs to ensure backward compatibility.

​
Example Versions

v1
v2
v3

​
Example

https://api.eazemyapi.com/demo-project/users/v2/list
Versioning allows your application to continue working even when new features are added.

​
Endpoint Naming Convention

Endpoints in EazeMyAPI follow a simple and predictable CRUD-based structure.
ActionDescription
listFetch all records
createCreate new record
update/{id}Update existing record
delete/{id}Delete record by ID
These APIs are automatically generated based on your database tables.

​
Authentication Header

Every request must include the API signature header. 
X-API-SIGNATURE: your-secret-key
Learn more about authentication: Authentication

​
Best Practices

When building API requests:
  • Always include the API signature header
  • Use the correct table name in URL
  • Validate request parameters
  • Use HTTPS for secure communication
Learn how APIs are generated automatically: Generate API Explore available endpoints: API Endpoints