Acme API v1.0
⌕ ⌘ K
REST API · Documentation

Build with Acme API.

Простая REST API для управления пользователями, проектами и событиями. Эта страница демонстрирует структуру интерактивной документации — endpoint'ы, параметры, ответы и примеры запросов.

https://api.example.com/v1

Authentication

Используйте API key в HTTP-заголовке Authorization. 

Authorization: Bearer YOUR_API_KEY

Users

Управление пользователями приложения.

GET /users List users ⌄
Request
GET /v1/users?limit=20&page=1

Authorization: Bearer YOUR_API_KEY
Response · 200
{
  "data": [
    {
      "id":
        "usr_01H7X",
      "name":
        "John Doe",
      "email":
        "john@example.com"
    }
  ],
  "has_more":
    false
}
POST /users Create user ⌄
Request body
{
  "name": "John Doe",
  "email": "john@example.com"
}
Response · 201
{
  "id":
    "usr_01H7X",
  "name":
    "John Doe",
  "created_at":
    "2026-08-18T12:00:00Z"
}
DELETE /users/:id Delete user ⌄
Request
DELETE /v1/users/usr_01H7X

Authorization: Bearer YOUR_API_KEY
Response · 204
No Content

Projects

Создание и управление проектами.

GET /projects List projects ⌄
Request
GET /v1/projects
Response · 200
{
  "data": [
    {
      "id": "prj_01A2B",
      "name": "Website",
      "status": "active"
    }
  ]
}

Webhooks

Получайте уведомления о событиях в реальном времени.

POST /webhooks Create webhook ⌄
Request body
{
  "url": "https://example.com/webhook",
  "events": [
    "user.created"
  ]
}
Response · 201
{
  "id": "wh_01ABC",
  "url": "https://example.com/webhook",
  "active": true
}

Errors

API использует стандартные HTTP status codes. 

{
  "error": {
    "code": "invalid_request",
    "message": "Email is required"
  }
}