API Documentation
Welcome to the API documentation. This guide provides details on how to interact with our API, including endpoints, parameters, and response formats.
Overview
Our API is a RESTful interface that allows you to manage resources programmatically. All requests must include an API key in the header.
Authorization: Bearer <your-api-key>Endpoints
GET /api/users
Retrieves a list of users.
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| page | integer | Page number for pagination | No |
| limit | integer | Number of items per page | No |
Response
{
"status": "success",
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john@example.com"
},
...
],
"meta": {
"page": 1,
"limit": 10,
"total": 100
}
}Example Request
curl -X GET "https://api.example.com/api/users?page=1&limit=10" \
-H "Authorization: Bearer <your-api-key>"POST /api/users
Creates a new user.
Body Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | Full name of the user | Yes |
| string | Email address of the user | Yes |
Response
{
"status": "success",
"data": {
"id": 1,
"name": "John Doe",
"email": "john@example.com"
}
}Example Request
curl -X POST "https://api.example.com/api/users" \
-H "Authorization: Bearer <your-api-key>" \
-H "Content-Type: application/json" \Error Handling
The API uses standard HTTP status codes to indicate the success or failure of a request.
| Status Code | Description |
|---|---|
| 200 | Request was successful |
| 400 | Bad request, check parameters |
| 401 | Unauthorized, invalid API key |
| 500 | Internal server error |