REST API, вебхуки, SDK и примеры для автоматизации: от подключения первого источника до публикации метрик в пайплайне. Всё, что нужно, чтобы встроить Statch в вашу инфраструктуру.
140+ эндпоинтов · SDK на Python и TypeScript · OpenAPI 3.1
От генерации токена до первого опубликованного KPI — без сборки окружения. Ниже минимальный путь для команды, которая хочет увидеть живую метрику сегодня.
Требуется только роль Developer в вашем рабочем пространстве. Полный доступ к данным не нужен.
kpi:read.POST /v2/kpis/{id}/recalculate.curl -X GET \
https://api.statch.dev/v2/kpis \
-H "Authorization: Bearer sk_live_9f4a..." \
-H "X-Workspace: hedge-alpha" \
-H "Accept: application/json"В ответе приходит список метрик с текущей версией, контрольной суммой и статусом валидации. Поле checksum_sha256 позволяет проверить целостность без повторного расчёта.
Версия v2 стабильна с марта 2024 года. Каждый ресурс описан в OpenAPI 3.1, доступна интерактивная песочница и строгие контракты для генерации клиентов.
Базовый URL: https://api.statch.dev. Все ответы — JSON, кодирование UTF-8.
Чтение и публикация метрик, история версий и запуск пересчёта по выбранной методике.
Синхронизация банковских и торговых систем, правила согласованности и экспорт отчётов в PDF/CSV.
Управление ролями, приглашения и неизменяемый аудит-трейл для внешних проверяющих.
Коды ответов. 200 — успех; 202 — пересчёт принят в очередь; 409 — конфликт версий, нужен If-Match; 429 — превышен лимит, смотрите заголовок Retry-After.
Подписывайтесь на ключевые события и реагируйте мгновенно — от завершения валидации до публикации квартального отчёта. Каждый вызов подписывается и защищён от подделок.
События доставляются с ретраями по экспоненциальной задержке до 24 часов.
import hmac, hashlib
sig = request.headers["Statch-Signature"]
payload = request.get_data()
expected = hmac.new(
secret, payload, hashlib.sha256
).hexdigest()
assert hmac.compare_digest(sig, expected)Секрет подписи задаётся при создании вебхука. Никогда не храните его на клиенте.
Отправьте тестовое событие без изменения данных:
curl -X POST \
https://api.statch.dev/v2/webhooks/{id}/test \
-H "Authorization: Bearer sk_live_..."Токены Statch — это bearer-ключи с минимально необходимыми правами. Мы советуем выдавать отдельный токен под каждую задачу и ротировать их не реже 90 дней.
Все запросы — только по HTTPS. Токены передаются в заголовке Authorization и никогда не попадают в URL.
Тестовые ключи sk_test_ не трогают реальные данные. Продакшен-ключи sk_live_ работают только в активном рабочем пространстве.
Выбирайте гранулярные права: kpi:read, kpi:write, report:export, webhooks:manage. Принцип наименьших привилегий — по умолчанию.
Каждый токен можно мгновенно отозвать или заменить. При ротации старый ключ остаётся валидным 24 часа — достаточно времени, чтобы переключить все пайплайны без простоя.
Базовый лимит — 1200 запросов в минуту на токен, с burst до 2000. Текущий остаток возвращается в заголовках X-RateLimit-Limit и X-RateLimit-Remaining. При превышении приходит 429 с заголовком Retry-After.
Да. Тестовые токены sk_test_ работают в изолированной среде с синтетическими источниками. Все операции — создание метрик, пересчёт, публикация — выполняются, но не влияют на продакшен.
Передайте заголовок Idempotency-Key с уникальным UUID. Повторный запрос с тем же ключом вернёт исходный результат, а не запустит пересчёт заново. Ключ хранится 7 дней.
Официальные SDK — Python (3.9+) и TypeScript (Node 18+). Для Go, Java и Rust можно сгенерировать клиент из OpenAPI-спецификации. API полностью описан в OpenAPI 3.1, так что любой генератор типов справится.
Каждая версия KPI содержит поле checksum_sha256. Сравнив его со значением в read-only слайде, аудитор подтверждает, что данные не менялись после публикации — без доступа к вашему рабочему пространству.