Developers


BizHub

Публичный read API для CRM, скриптов и агентских дашбордов. Кабинет остаётся с самостоятельной регистрацией — API не заменяет онбординг и не требует менеджера.

Открыть спецификацию Скачать OpenAPI YAML Создать аккаунт

Быстрый старт

  1. Зарегистрируйтесь в кабинете
  2. Создайте API-ключ: Аккаунт → API-ключи (или JWT через POST /api/v1/auth/login)
  3. Передавайте Authorization: Bearer bh_live_… (или JWT)
  4. Проверьте ключ: GET /api/v1/me (поле auth_via)
  5. Читайте организации, отзывы, метрики, presence и портфель (см. спеку ниже)
# Каталог интеграции (без auth)
curl -sS https://bizhub.com.ru/api/v1/integration/catalog | jq .

# Долгоживущий ключ из кабинета (Аккаунт → API-ключи)
curl -sS https://bizhub.com.ru/api/v1/me \
  -H "Authorization: Bearer bh_live_…"

# Или короткоживущий JWT
curl -sS -X POST https://bizhub.com.ru/api/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"email":"you@example.com","password":"…"}'

Управление ключами (/api/v1/api-keys) — только JWT-сессия кабинета, не самим API key. Ошибки — JSON {"error":"…"}. Площадки live/manual — на /platforms.

CRM recipe

  1. Кабинет → Уведомления → Webhooks → HTTPS URL вашего приёмника
  2. Скачайте sample: /samples/crm-webhook-receiver.py
  3. Проверяйте X-BizHub-Timestamp + HMAC timestamp.body
  4. На 5★ можно ответить через POST /api/v1/reviews/{id}/reply (API key); ≤3★ — только в approve queue

Каталог событий и путей: GET /api/v1/integration/catalog.

Reviews → Helpdesk

Мост в Usedesk / Bitrix24 за ~час: тот же HMAC, плюс создание тикета. Не marketplace-приложение — self-serve sample.

  1. Скачайте /samples/helpdesk-webhook-receiver.py
  2. HELPDESK_MODE=log для smoke; затем usedesk или bitrix
  3. Usedesk: USEDESK_API_URL + USEDESK_API_TOKEN
  4. Bitrix: incoming webhook URL + опц. BITRIX_ENTITY_ID
  5. Опц. BIZHUB_API_KEY — auto-reply только на 5★
export BIZHUB_WEBHOOK_SECRET=whsec_…
export HELPDESK_MODE=log   # или usedesk|bitrix
python3 helpdesk-webhook-receiver.py
# Webhook URL: https://your-host:8788/bizhub/webhook

Recipe id в catalog: reviews_helpdesk.

Что в v1.3.1

  • me / catalogGET /api/v1/me, GET /api/v1/integration/catalog
  • organizations — список точек workspace
  • reviews — inbox + reply / approve / appeal
  • presence — completeness, card-quality, presence-audit/latest, 2GIS Card Ops
  • citations — catalog / slots / niche-pack / link / recheck (FEATURE_CITATION_LAYER; manual-assist)
  • analytics/reputation — аспекты + keyword + ★ Δ (P5; FEATURE_ANALYTICS_HUB)
  • helpdesk sample/samples/helpdesk-webhook-receiver.py (Usedesk / Bitrix)
  • messaging — Domclick chats Bearer Pro (FEATURE_MESSAGING_DOMCLICK; не OAuth)
  • local_seo — positions, competitors/light
  • metrics — рейтинг, % ответов, тренды
  • analytics/portfolio — сводка сети + POST …/portfolio/reports (batch /rpts) + network-week.html
  • client_ops — intake / client-share / публичный /client/{token} (FEATURE_CLIENT_OPS); geo-grid (FEATURE_GEO_GRID)
  • review-invites — email-кампании smart-link (Phase 7)
  • api-keys — создание/отзыв (только JWT); bh_live_* на API
  • webhooksreview.created / review.replied, HMAC, retry, deliveries

CRM loop: webhook review.created → ваш бот → POST /api/v1/reviews/{id}/reply (или approve) → webhook review.replied. Payload: { id, event, data.review }. Подпись Stripe-style: HMAC-SHA256(secret, "{unix}.{body}") — заголовки X-BizHub-Timestamp, X-BizHub-Signature, X-BizHub-Event, X-BizHub-Delivery. Лог: GET …/webhooks/{id}/deliveries. Настройка: кабинет → Уведомления.

Live vs manual-assist: /platforms. Publish/ads и прочий write остаются в кабинете; публичная спека — read-core + CRM reply + citations/messaging. Ключ действует от имени пользователя (все его org).

Спецификация OpenAPI

Источник истины: /openapi/v1.yaml. Ниже — тот же файл в Redoc.

Нужна помощь с заведением карточек?

Опциональный консьерж — заявка оператору. Self-serve регистрация при этом остаётся основным путём.

Заявка консьержу Для агентств