Партнёрский API

Read-only REST API для выгрузки вашей воронки, лидов, конверсий и заработка в ваши системы (CAPI, трекеры, дашборды).

Base URL

https://<your-host>/api/v1

Все эндпоинты версионированы под /api/v1 и возвращают JSON. Поддерживается только GET (плюс один POST для ссылок входа).

Аутентификация

Аутентифицируйтесь API-ключом как bearer-токеном. Один ключ выпускается автоматически вместе с аккаунтом; смотреть, копировать и ротировать — в разделе API портала.

Authorization: Bearer wk_live_xxxxxxxxxxxxxxxxxxxx

warning

Ключи секретны. Мы храним только хэш для проверки, так что утёкший ключ восстановить нельзя — ротируйте. Ротация мгновенно отзывает старый ключ. API — server-to-server: никогда не светите ключ в браузере или мобильном клиенте.

Конверт ответа

Каждый ответ — один из двух:

Успех

{ "ok": true, "data": { /* payload эндпоинта */ } }

Ошибка

{ "ok": false, "error": { "code": "unauthorized", "message": "Invalid or revoked API key." } }

Ошибки

HTTP	code	Значение
401	unauthorized	Ключ отсутствует, неверен или отозван.
404	not_found	Ресурс не существует или не ваш.
429	rate_limited	Превышен лимит — см. заголовок Retry-After.
500	internal	Непредвиденная ошибка сервера.

Лимиты запросов

• 120 запросов / минуту на ключ (плюс потолок на IP).
• На 429 приходит заголовок Retry-After (в секундах). Подождите и повторите.

Пагинация

Списковые эндпоинты используют opaque-курсоры. Передайте возвращённый курсор, чтобы получить следующую страницу.

• /conversions — восходящий прямой поток: идеален для поллинга «всё с прошлого раза». Храните последний nextCursor и передавайте его в следующем полле.
• /leads — от новых к старым.
• nextCursor: null — конец текущего окна.

Ограничения параметров

Параметр	По умолчанию	Ограничение
from / to	последние 30 дней	ISO-8601; максимум 92 дня (обрезается).
limit	100	максимум 500 (обрезается).

Что раскрывается (и что нет)

• Всё ограничено вашими доменами — чужих данных вы не видите никогда.
• Данные конверсий/лидов включают атрибуцию и match-сигналы (ip, user_agent, fbp, fbc, fbclid) и суммы депозитов — достаточно для server-событий Meta CAPI.
• Маржа платформы (GGR/net, выводы) не раскрывается никогда. Денежные поля — ваши закупочные значения и ваш заработок.

подсказка

Каждый маршрут с параметрами и примерами ответов — в справочнике эндпоинтов.