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-вікні. Окремо зберігайте останню успішну синхронізацію та помилки. Підтримці надавайте шлях без секретів, час, код відповіді та знеособлений опис.