API: подключение и получение данных
Как подготовить интеграцию AffiliateCore: токены, права, запросы, пагинация, статистика конверсий и обработка ошибок.
API v1 запущен 10 октября 2026. Используйте его для чтения данных своей роли и проекта. Токен создаётся владельцем доступа в кабинете; наличие ссылки на гайд само по себе не предоставляет права.
Что можно получить
API предназначен для чтения данных в собственной интеграции. Вебмастер получает доступный каталог офферов, свои кампании и конверсии. Рекламодатель — данные своего проекта, его офферы, кампании и конверсии. Статистика считает записи конверсий по дням и статусам, а не уникальных посетителей, клики, доход или баланс. Создание офферов, подключение кампаний, пополнение и вывод через эту версию не предусмотрены.
Как подключиться
- Войдите в кабинет нужной роли. Подтвердите email и выполните требования аккаунта.
- Откройте «Аккаунт и настройки» → «Доступ к API». Для рекламодателя требуется роль владельца выбранного проекта; менеджер или финансовая роль сами по себе не дают права выдачи токена.
- Назовите интеграцию, выберите только необходимые права и подтвердите текущим паролем. Например, для сводки конверсий достаточно
publisher:analytics:read. - Сохраните токен сразу в защищённом хранилище: повторно показать его нельзя. Срок — 30 дней, максимум пять активных токенов на пользователя в контексте. Для другой роли или проекта нужен отдельный токен.
- Передавайте токен только по HTTPS в заголовке
Authorization: Bearer. Не помещайте его в URL, публичный JavaScript, переписку или журналы. При включённом MFA выдача в этой версии недоступна: не отключайте защиту ради интеграции, обратитесь в поддержку.
Запрос и результат
Ниже учебный запрос для вебмастера. YOUR_TOKEN — обозначение, не действующий ключ. Число в пути рекламодателя — числовой ID своего проекта, не его slug. Права для ресурсов независимы: доступ к аналитике не разрешает выгрузку отдельных конверсий.
GET /api/v1/publisher/analytics?from=2026-10-01&to=2026-10-07
Host: affiliate-core.com
Authorization: Bearer YOUR_TOKEN
Accept: application/json
| GET | Scope |
|---|---|
/api/v1/publisher/offers |
publisher:offers:read |
/api/v1/publisher/campaigns |
publisher:campaigns:read |
/api/v1/publisher/conversions |
publisher:conversions:read |
/api/v1/publisher/analytics |
publisher:analytics:read |
/api/v1/advertiser/{id}/company |
advertiser:company:read |
/api/v1/advertiser/{id}/offers |
advertiser:offers:read |
/api/v1/advertiser/{id}/campaigns |
advertiser:campaigns:read |
/api/v1/advertiser/{id}/conversions |
advertiser:conversions:read |
/api/v1/advertiser/{id}/analytics |
advertiser:analytics:read |
Страницы и период
Списки возвращают data и meta.next_cursor. По умолчанию per_page=25, допустимо 1–100. Передавайте полученный cursor с неизменными фильтрами и размером страницы, пока next_cursor не станет null. Не расшифровывайте и не конструируйте курсор вручную. Ответ отдельного объекта и аналитики находится в data.
Для конверсий и аналитики from и to задаются как YYYY-MM-DD в UTC, обе даты включены. Максимум 30 календарных дней, по умолчанию последние 30 дней. Будущие даты запрещены. Используется дата события event_at. Например, 1–7 октября — семь суток; 10 сентября – 9 октября — 30 суток. Большую историю разбивайте на окна.
Списки офферов принимают status и payout_model, кампаний — status и offer_id; конверсий — status, event_type, offer_id, campaign_id, from, to. Аналитика принимает последние пять параметров без status. Детали объектов и company не принимают query-параметров. Неизвестные поля дают 422. Нулевой успешный результат означает отсутствие записей в выбранном окне; 503 не означает ноль конверсий.
Ошибки и обслуживание
401 — проверьте токен и срок; 403 — права и состояние аккаунта; 404 — объект недоступен или отсутствует, либо API выключен; 405 — неподдерживаемый метод; 422 — параметры; 429 — дождитесь Retry-After; 503 — временно недоступен сервис, повторите с задержкой. Не повторяйте 401/403 бесконечно.
Лимит — 60 запросов в минуту на пользователя между токенами; аналитика дополнительно ограничена 10 запросами в минуту на пользователя/контекст. Для обновления ключа выпустите новый, замените его в интеграции, затем отзовите старый. Смена пароля прекращает действие прежних токенов. При утечке немедленно отзовите ключ.
Проверьте сначала небольшой период, сравните число записей и статусы с кабинетом за тот же UTC-период. Храните время последней успешной синхронизации и ошибки отдельно от данных. При обращении в поддержку приложите путь без токена, время, код ответа и обезличенное описание.