Admin API: настройки

16 методов работают с тем же, что и раздел Настройки в панели: основные параметры и бот-листы, гео-профили, курсы валют и очистка журнала аудита. Всем методам нужен токен с доступом Полный доступ (full).

Авторизация описана на странице Admin API: обзор и авторизация, формат запросов, ответов и общие коды ошибок — на странице Формат запросов, ответов и ошибок.

Настройки и версия

Настройки — один JSON-объект с ключами и служебным полем _revision. Версия увеличивается на 1 при каждом сохранении. По ней трекер отклоняет запись поверх чужих изменений.

Что означает каждый параметр — на страницах Настройки: основные параметры и бот-листы и Определение ботов и свои бот-листы.

Получить настройки

GET /api/v1/settings

Возвращает сохранённые ключи и _revision. Параметров нет. Ключ, который ещё ни разу не сохраняли, в ответе отсутствует — для него действует значение по умолчанию. Пока настройки не меняли, _revision равен 0.

{"s2s_timeout_sec": 10, "report_attribution": "click", "allow_php": true, "bot_ua": ["MyScanner"], "bot_ip": ["203.0.113.0/24"], "_revision": 7}

Изменить настройки

PATCH /api/v1/settings
PUT /api/v1/settings

Меняет только переданные ключи, остальные сохраняются. Массивы bot_ua и bot_ip заменяются целиком.

PUT без _revision сохраняет значения без сверки версии. С _revision оба метода работают одинаково.

Ответ — код 200 и все настройки с новым _revision.

curl -X PATCH https://panel.example.com/api/v1/settings \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"_revision":7,"s2s_timeout_sec":15,"bot_ip":["203.0.113.10","203.0.113.0/24"]}'

Гео-профили

Гео-профиль — именованный набор стран для условия «Гео» в потоке. Работа с профилями в панели — на странице Гео-профили.

Получить список профилей

GET /api/v1/geo-profiles

Возвращает массив: сначала 14 встроенных профилей, затем свои по алфавиту. Параметров нет. Встроенные профили изменить и удалить нельзя.

Создать профиль

POST /api/v1/geo-profiles

Ответ — код 200 и объект профиля с id.

curl -X POST https://panel.example.com/api/v1/geo-profiles \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Tier 1","countries":["US","CA","GB","AU"]}'

Изменить профиль

PUT /api/v1/geo-profiles/{id}

Заменяет название и список стран профиля {id}. Поля тела те же, что при создании, оба обязательны. Ответ — код 200 и объект профиля.

Ошибки создания и изменения:

Удалить профиль

DELETE /api/v1/geo-profiles/{id}

Удаляет свой профиль. Ответ — код 204 без тела. Потоки, в которые уже вставлены страны профиля, не меняются. Если профиля нет — 404 с кодом not_found. Если {id} не UUID — 400 с кодом bad_request.

Курсы валют

Курс — сколько USD стоит одна единица валюты на дату. Как трекер выбирает курс для пересчёта — на странице Валюты и курсы.

Получить историю курсов

GET /api/v1/currency-rates

Возвращает массив ручных и автоматических курсов — до 1000 строк, новые даты первыми. Параметров нет.

Добавить ручной курс

POST /api/v1/currency-rates

Ответ — код 201 и добавленный курс с source = manual.

{"currency": "EUR", "day": "2026-10-01", "usd_rate": 1.1, "source": "manual"}

Получить состояние автоматических курсов

GET /api/v1/currency-rates/provider

Параметров нет. Ответ — код 200 и объект:

Включить или выключить автоматические курсы

PUT /api/v1/currency-rates/provider

Ответ — код 200 и объект состояния. Без поля automatic или с телом не в JSON — 422 с кодом validation и сообщением Укажите режим обновления курсов.

Обновить курсы сейчас

POST /api/v1/currency-rates/refresh

Запрашивает курсы у источника вне расписания. Тела нет. Источник опрашивается не чаще раза в минуту: повторный запрос раньше вернёт текущее состояние. Ответ — код 200 и объект состояния.

Если источник не ответил — 502 с кодом currency_provider. Сохранённые курсы продолжают действовать, пока им не больше 7 дней.

Очистка журнала аудита

Очистка удаляет старые записи журнала действий и выгрузки CSV с истёкшим сроком. Перед разовой очисткой и перед включением автоочистки нужна оценка: она возвращает token и границу before, которые передаются в следующий запрос. Правила и сроки — на странице Хранение данных и очистка журнала аудита.

Получить состояние очистки

GET /api/v1/retention/status

Параметров нет. Ответ — код 200 и объект:

Оценить очистку

POST /api/v1/retention/preview

Считает, сколько записей попадёт под очистку. Ничего не удаляет.

Ответ — код 200:

Выполнить очистку

POST /api/v1/retention/apply

Ответ — код 200 и объект с полями before, audit_rows, expired_exports — сколько удалено. За один запрос удаляется до 10000 записей аудита и до 100 выгрузок. Если осталось больше, повторите запрос: в течение 15 минут подходят те же before и token, позже нужна новая оценка.

curl -X POST https://panel.example.com/api/v1/retention/apply \
  -H "Api-Key: <токен>" \
  -H "Content-Type: application/json" \
  -d '{"days":90,"before":"2026-07-06T12:00:00Z","token":"<token из оценки>"}'

Сохранить правило автоочистки

PUT /api/v1/retention/policy

Включает, выключает ежедневную автоочистку или меняет её срок.

Ответ — код 200 и объект enabled, audit_days, revision, next_run. revision в ответе на 1 больше переданного. После включения, выключения или смены срока next_run — через 24 часа.

Ошибки методов очистки: