Aladdin Public API

Ошибки

400, 401, 403, 404, 429 — моковые тела ответов.

Ошибки

Публичный API отвечает JSON-телом Nest-формата. Ниже — обобщённые примеры (не боевые данные).

КодМетодКогда
400любой GET с queryНевалидные query (UUID, limit, конфликт *On с *From/*To)
401любойНет токена, неверный, отозванный или просроченный
403любойНет скоупа или IP не в allowlist
404GET …/{id}Ресурс не найден или не виден субъекту токена
429любойПревышен rate limit (глобальный или per-token)

400 Bad Request

{
  "statusCode": 400,
  "message": "Do not combine createdOn with createdFrom/createdTo",
  "error": "Bad Request"
}
{
  "statusCode": 400,
  "message": ["limit must not be greater than 100"],
  "error": "Bad Request"
}

401 Unauthorized

GET /v1/tasks HTTP/1.1
Host: api.aladdinhub.io
Accept: application/json

(без Authorization или с неверным Bearer)

{
  "statusCode": 401,
  "message": "Invalid or expired API token",
  "error": "Unauthorized"
}

403 Forbidden — скоуп

{
  "statusCode": 403,
  "message": "Missing required API token scope: boards:read",
  "error": "Forbidden"
}

403 Forbidden — IP allowlist

{
  "statusCode": 403,
  "message": "Client IP is not allowed for this token",
  "error": "Forbidden"
}

404 Not Found

{
  "statusCode": 404,
  "message": "Task not found",
  "error": "Not Found"
}
{
  "statusCode": 404,
  "message": "Board not found",
  "error": "Not Found"
}

429 Too Many Requests

{
  "statusCode": 429,
  "message": "Too Many Requests",
  "error": "Too Many Requests"
}

Секрет токена и заголовок Authorization не пишутся в серверные логи.

Подробные сценарии по ресурсам: Задачи, Доски, Сотрудники.