Alumica API для интеграций
Версионированный HTTP API. Предсказуемый JSON, трассировка запросов и единый формат ошибок.
v1application/jsonBackwards-compatibleReference
Быстрый старт, примеры запросов и интерактивная проверка health endpoint.
-
GET
/api/health
Проверка состояния и доступности.
-
GET
/api/me
Возвращает идентичность токена и права доступа.
-
ANY
/api/*
Стандартные ресурсы (проекты, события, клиенты, …).
{}
Authentication
Аутентификация через bearer-токены в заголовке Authorization.
-
HDR
Authorization: Bearer <TOKEN>
Обязателен для защищённых методов.
-
INFO
Скоупы и права
Токены могут быть ограничены принципом минимальных привилегий.
Rate limits
Лимиты применяются на токен и возвращаются заголовками. Клиентам рекомендуется учитывать Retry-After.
-
429
rate_limited
Слишком много запросов. Рекомендуется экспоненциальный backoff.
-
HDR
X-RateLimit-Limit / Remaining
Возвращается в ответах, где применимо.
Errors
Единый JSON-конверт ошибок со стабильными полями.
{
"error": {
"type": "invalid_request",
"message": "Missing required parameter: email",
"request_id": "req_01HR9X9V0GJ6R9E2R4QK"
}
}
-
400
invalid_request
Некорректный запрос или отсутствуют параметры.
-
401
unauthorized
Отсутствует или неверный токен.
-
403
forbidden
Недостаточно прав для операции.
Status
Обзор статуса сервиса и health endpoint для мониторинга.
Changelog
Обратноссовместимые изменения и улучшения.