Alumica API для интеграций

Версионированный HTTP API. Предсказуемый JSON, трассировка запросов и единый формат ошибок.

v1 стабильный JSON ответы X-Request-ID трассировка Авторизация Bearer
Окружение
Production
Версия
v1
Content-Type
application/json
Совместимость
Backwards-compatible

Reference

Быстрый старт, примеры запросов и интерактивная проверка health endpoint.

  • GET

    /api/health

    Проверка состояния и доступности.

    200jsonno-store
  • GET

    /api/me

    Возвращает идентичность токена и права доступа.

    auth200
  • ANY

    /api/*

    Стандартные ресурсы (проекты, события, клиенты, …).

    jsonversioned
GET /api/health
X-Request-ID:
{}
Нажмите «Запрос», чтобы выполнить вызов прямо из браузера.

Authentication

Аутентификация через bearer-токены в заголовке Authorization.

  • HDR

    Authorization: Bearer <TOKEN>

    Обязателен для защищённых методов.

    401403
  • INFO

    Скоупы и права

    Токены могут быть ограничены принципом минимальных привилегий.

    least-privilege

Rate limits

Лимиты применяются на токен и возвращаются заголовками. Клиентам рекомендуется учитывать Retry-After.

  • 429

    rate_limited

    Слишком много запросов. Рекомендуется экспоненциальный backoff.

    Retry-AfterX-RateLimit-*
  • HDR

    X-RateLimit-Limit / Remaining

    Возвращается в ответах, где применимо.

    observability

Errors

Единый JSON-конверт ошибок со стабильными полями.

{
  "error": {
    "type": "invalid_request",
    "message": "Missing required parameter: email",
    "request_id": "req_01HR9X9V0GJ6R9E2R4QK"
  }
}
  • 400

    invalid_request

    Некорректный запрос или отсутствуют параметры.

    client
  • 401

    unauthorized

    Отсутствует или неверный токен.

    auth
  • 403

    forbidden

    Недостаточно прав для операции.

    policy

Status

Обзор статуса сервиса и health endpoint для мониторинга.

Основной API
Работает
Last incident:
Сервис токенов
Работает
JSON endpoint: /api/health

Changelog

Обратноссовместимые изменения и улучшения.

    © Alumica ·
    Шорткаты: / для поиска