OpsVault knowledge base

Binom 2 — Public API и схема OpenAPI

Раздел: Документации / Binom 2. Обновлено 30.09.2026 16:38.

Binom 2 — Public API и схема OpenAPI

Полная инструкция из базы знаний OpsVault.

Для трекера Binom 2. Проверено 30 сентября 2026.

Public API Binom 2 отличается от классического ARM API v2. В экспортированной схеме пути начинаются с /public/api/v1: цифра v1 здесь — версия API, а не поколение трекера.

Где брать контракт

Откройте /api/doc на домене своей установки. Ключ текущего пользователя находится в Settings → User и передаётся заголовком Api-Key. Права ограничиваются доступом этого пользователя; для интеграции используйте отдельного пользователя с нужной областью. Swagger Authorize сохраняет ключ для запросов в открытом интерфейсе — не включайте его в снимки или общую документацию.

Вложенная схема

Это снимок OpenAPI 3.0.0 официального демо Binom, полученный 30.09.2026: 301 маршрут. Удалены примеры значений, чтобы распространять контракт без образцов реквизитов. Схема содержит описания параметров, типов, ответов и авторизации; это не выгрузка кампаний пользователей.

Как использовать

  1. Импортируйте JSON в совместимый API-клиент как справочник.
  2. Сравните нужную операцию с /api/doc своей установленной версии. В снимке нет номера релиза конкретного production-трекера.
  3. Передайте свой ключ локально заголовком, затем выполните одну разрешённую операцию чтения.
  4. Обрабатывайте все страницы отчёта и проверяйте HTTP-статус вместе со структурой JSON.

Не запускайте все методы подряд. В схеме есть операции записи и удаления; некоторые GET тоже изменяют данные. Для кликов Binom отдельно документирует Click API — это не замена Public API.

Первоисточники

Документации · Все справки Binom 2

Вложения