Справочник эндпоинтов

Все эндпоинты доступны под префиксом /api/v1/public/ на https://api.vibevo.io и требуют API-ключ с нужным скоупом.

Идентификация ключа

• GET /me — данные текущего ключа (кто владелец, скоупы). Достаточно любого валидного ключа.

Кампании (для рекламодателя)

• GET /campaigns — список ваших кампаний (бюджет, потрачено, статус). Скоуп read. Курсорная пагинация.
• GET /campaigns/{id} — одна кампания. Скоуп read.
• GET /campaigns/{id}/posts — посты кампании. Скоуп read. Курсор + необязательный фильтр по статусу.
• GET /campaigns/{id}/creators — креаторы, агрегированные по аккаунту и отсортированные по просмотрам. Скоуп read.
• GET /campaigns/{id}/tracking-links — трекинг-ссылки с uniqueClicks. Скоуп read.

Офферы (для креатора)

• GET /offers — лента доступных офферов (RUNNING-кампаний, которые креатор может взять), с полями оффера: ставка/CPM, требования, takenAt. Без бюджета/потраченного рекламодателя. Скоуп read. Курсорная пагинация.
• GET /posts — ваши поданные посты по всем кампаниям: статус, просмотры, заработок, кампания, аккаунт, дата подачи; плюс summary (всего постов, на модерации, заработано всего). Скоуп read. Курсор + необязательные фильтры status, platform.

Аналитика

• GET /analytics/campaigns/{id} — аналитика кампании. Скоуп read.

Кошелёк

• GET /wallet — текущий баланс. Скоуп read.
• GET /wallet/transactions — история биллинга. Скоуп read. Курсорная пагинация.

Курсорная пагинация

Списочные эндпоинты используют курсорную пагинацию. Передайте limit (от 1 до 100) и cursor (идентификатор последнего элемента предыдущей страницы):

GET /api/v1/public/campaigns?limit=50&cursor=1234

Ответ содержит массив данных и курсор следующей страницы:

{
  "data": [ /* ... */ ],
  "nextCursor": "5678"
}

Когда nextCursor равен null, страниц больше нет.

Формат денег

Денежные значения возвращаются структурой:

{
  "raw": "1500",
  "currency": "USD",
  "decimals": 2
}

raw — целое число в минимальных единицах, переданное строкой; реальное значение = raw / 10^decimals. Обратите внимание на разные масштабы:

• Бюджеты кампаний и заработок по постам — центы: decimals: 2, валюта USD (например, raw: "1500" = 15.00 USD).
• Баланс кошелька и транзакции биллинга — минимальные единицы USDT: decimals: 6.

Формат ошибок

Ошибки возвращаются единым конвертом:

{
  "statusCode": 403,
  "code": "insufficient_scope",
  "message": "Missing required scope: read",
  "timestamp": "2026-07-11T12:00:00.000Z",
  "path": "/api/v1/public/campaigns"
}

Ориентируйтесь на строковое поле code для программной обработки — оно стабильнее, чем человекочитаемый message.

Примеры curl

Список кампаний (заголовок Bearer):

curl https://api.vibevo.io/api/v1/public/campaigns?limit=20 \
  -H "Authorization: Bearer vibevo_live_ab12cd.xxxxxxxxxxxxxxxx"

Баланс кошелька (заголовок X-API-Key):

curl https://api.vibevo.io/api/v1/public/wallet \
  -H "X-API-Key: vibevo_live_ab12cd.xxxxxxxxxxxxxxxx"

Обновлено: 11 июля 2026