Документация для разработчиков

Обзор API Логкит

Интегрируйте мощь консолидации логов в ваши системы. RESTful-архитектура, JSON-ответы и полная типизация для быстрого старта.

Открыть песочницу Скачать SDK

Фундамент

Базовые принципы REST API

API Логкит спроектирован по стандартам REST. Мы используем стандартные HTTP-методы для манипуляции ресурсами: GET для чтения логов, POST для отправки новых потоков, PUT для обновления конфигураций.

Иерархия ресурсов

Логическая структура URL отражает иерархию данных: /api/v1/tenants/{id}/streams. Никаких скрытых параметров.

JSON & UTF-8

Все запросы и ответы используют формат JSON с кодировкой UTF-8. Мы поддерживаем строгую типизацию полей дат (ISO 8601).

Обработка ошибок

Стандартные коды HTTP (4xx, 5xx). В теле ответа всегда содержится объект { "error": { "code": "...", "message": "..." } }.

Безопасность

Аутентификация и ключи

Мы используем Bearer-токены для аутентификации. Ключи создаются в разделе "Настройки организации" и имеют гибкую систему прав доступа (Read-Only, Read-Write, Admin).

        Authorization: Bearer lk_live_8f7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c
      

* Никогда не публикуйте ключи в клиентском JavaScript коде. Используйте прокси-сервер или бэкенд для запросов.

Секретные ключи (Secret Keys)

Имеют полный доступ к API. Используйте только на серверной стороне. При компрометации ключа мгновенно блокируется доступ ко всем потокам.

Публичные ключи (Publishable Keys)

Ограничены правами только на чтение (GET) и базовую статистику. Безопасны для использования в фронтенд-приложениях.

Формат данных

Структура запросов и ответов

Пример ответа (GET /logs)

{
  "data": [
    {
      "id": "txn_29384756",
      "timestamp": "2023-10-27T10:15:30Z",
      "amount": 15000.00,
      "currency": "RUB",
      "status": "success",
      "source": "payment_gateway_a"
    }
  ],
  "meta": {
    "total_count": 15402,
    "page": 1,
    "limit": 20
  }
}

Пагинация

Все конечные точки, возвращающие списки (логи, транзакции, пользователи), поддерживают курсорную и.offset пагинацию.

limit: Максимальное количество записей (по умолчанию 20, макс. 100).
cursor: Идентификатор последней записи предыдущей страницы.
sort: Направление сортировки (asc/desc).

Надежность

Лимиты запросов (Rate Limiting)

Чтобы обеспечить стабильность платформы для всех клиентов, мы применяем ограничения на частоту запросов. Лимиты привязаны к вашему API-ключу.

100

Запросов в минуту

Тариф "Стартап". Подходит для базового мониторинга и редких отчетов.

1,000

Запросов в минуту

Тариф "Бизнес". Для активных интеграций и синхронизации в реальном времени.

∞

Dedicated

Тариф "Enterprise". Выделенный шлюз без ограничений пропускной способности.

При превышении лимита API вернет статус 429 Too Many Requests.
Информация о текущем лимите доступна в заголовках ответа: X-RateLimit-Remaining.

Нужна помощь с интеграцией?

Наши инженеры помогут настроить вебхуки, протестировать песочницу и оптимизировать запросы под вашу нагрузку.

Связаться с техподдержкой