Парный ключ
Ключ rx_live_… и 32-символьный секрет. Ключ — публичная часть, секрет хранится только на вашем бэкенде и не покидает сервер.
Документация · API v3.2
Документация API
Всё, что нужно, чтобы собрать конвейер Regexly: от получения токена до обработки вебхуков. Каждый пример можно скопировать и отправить на тестовый стенд без ключей.
Шаг 01 · Аутентификация
Как получить и передать ключ
Все запросы защищаются парным ключом. Ключ и секрет генерируются в консоли и никогда не передаются по сети целиком — из них выводится подпись.
Подпись HMAC-SHA256
Подпись вычисляется из строки метод + путь + timestamp + body. Отклонение по времени более 300 секунд отклоняется как 401.
Заголовки
Пары X-Regexly-Key, X-Regexly-Signature и X-Regexly-Timestamp обязательны. Для отладки доступен sandbox без подписи.
Шаг 02 · Эндпоинты
Что можно запросить
Группы сгруппированы по смыслу. Методы строго ограничены: чтение — GET, запись — POST, удаление — DELETE.
01
Источники и потоки
GET /sources · POST /sources · GET /sources/{id}/streams — подключение, список и контроль входящих потоков данных.
02
Запросы и извлечения
POST /queries · GET /queries/{id} · GET /queries/{id}/results — запуск строгого запроса и получение результатов с погрешностью.
03
Отчёты и выводы
GET /reports · POST /reports/{id}/export · GET /insights — генерация отчётов, экспорт в PDF/CSV/XLSX и список подтверждённых выводов.
04
Вебхуки и события
GET /webhooks · POST /webhooks · POST /webhooks/{id}/test — настройка подписок на события и отправка тестового события.
05
Квоты и биллинг
GET /usage · GET /billing/invoices — текущее потребление, лимиты тарифа и история счётов по организации.
Шаг 03 · Примеры
Запрос — ответ, без воды
Ниже — реальные примеры с тестовым ключом rx_sandbox_01HTQ. Ответы отформатированы, погрешность указана рядом с каждой метрикой.
curl · POST /v3/queries
200 OK
методPOST /v3/queriesчтение
тело{"source":"tx-042","window":"24h","metric":"gmv"}UTF-8
ответ{"id":"q_9f2c","rows":1842210}128 мс
погрешность±0,03% на выборкевзвешено
источникtx-042 · 8,4 млн строкOK
Создание источника
POST /sources с телом {"name":"orders","type":"jsonl"}. Возвращает id и ссылку на конвейер нормализации.
Строгий запрос с погрешностью
POST /queries с параметром precision:strict. Ответ содержит интервал доверия и ссылку на исходные записи.
Экспорт отчёта
POST /reports/r_2041/export с {"format":"pdf"}. Файл доступен по ссылке 72 часа, ссылки на строки сохранены.
Шаг 04 · Ошибки
Коды состояния и что с ними делать
Каждая ошибка несёт машиночитаемый код и человекочитаемое описание. Повторные попытки — только с экспоненциальной задержкой.
400Некорректный запрос · проверьте тело и параметры
401Ключ недействителен или подпись не прошла проверку
429Превышен лимит · заголовок Retry-After даёт паузу в секундах
503Временный сбой конвейера · повтор через 30–300 с
401
Ошибка аутентификации
Проверьте синхронизацию часов (NTP), корректность строки подписи и отсутствие пробелов в заголовках. Sandbox не требует подписи.
429
Ограничение частоты
План «Команда» — 600 запросов/мин, «Фирма» — 6000. При превышении заголовок Retry-After указывает паузу в секундах.
Шаг 05 · События
Вебхуки и события конвейера
Regexly отправляет события на ваш HTTPS-эндпоинт с подписью X-Regexly-Event-Signature. Повторная доставка — до 6 попыток с задержкой.
query.completed
Запрос завершён. Тело содержит query_id, число строк, время выполнения и ссылку на результаты. Приходит в течение 5 секунд после завершения.
anomaly.detected
Найдено отклонение. Тело включает метрику, порог, фактическое значение и ссылку на исходные записи. Ранжируется по влиянию на KPI.
Схема тела →source.degraded
Источнику не хватает данных или он отклоняется по схеме. Тело содержит код причины и список полей, которые не прошли валидацию.
Схема тела →Шаг 06 · Библиотеки
Готовые клиентские библиотеки
Официальные SDK для основных языков. Все поддерживают подписанные запросы, повторные попытки и типизацию ответов.
Pythonregexly-py · 3.2.1 · PyPI · от 3.9
JS/TS@regexly/sdk · 3.2.1 · npm · Node 18+
Gogithub.com/regexly/go · v3.2.1 · Go 1.21+
Rustregexly-rs · 3.2.1 · crates.io · async
SDK
Установка
Одна команда в менеджер пакетов. Ключ и секрет читаются из переменных окружения REGEXLY_KEY и REGEXLY_SECRET.
DOC
Справка и changelog
Полная документация, примеры и история изменений — на странице ресурсов. Разработчики получают уведомления о breaking changes за 30 дней.