Перейти к содержимому

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

Защищённые операции участника в API VibeVO используют API-ключи. Запрос должен содержать действующий ключ в заголовке; ключ определяет владельца, а его скоупы — доступные эндпоинты. Исключение — два гостевых GET каталога креаторов, описанных ниже.

Формат ключа

Ключ выглядит так:

vibevo_live_{prefix}.{secret}
  • prefix — короткий публичный идентификатор ключа (виден в кабинете, помогает узнать ключ в списке).
  • secret — секретная часть. Показывается только один раз при создании и больше нигде не отображается.
Секрет показывается один раз
Скопируйте полный ключ сразу после создания и храните его в защищённом месте (менеджер секретов, переменные окружения). Если ключ утерян — создайте новый и удалите старый.

Как создать ключ

Ключи создаются в кабинете на странице Настройки — внизу есть блок «API-ключи». При создании ключа вы:

  1. задаёте название (чтобы отличать ключи между собой);
  2. выбираете скоупы — набор разрешений для этого ключа;
  3. при необходимости задаёте срок действия (expiry);
  4. копируете полный ключ из окна — он показывается один раз.

Передача ключа в запросе

Поддерживаются два равнозначных заголовка — используйте любой:

Authorization: Bearer vibevo_live_ab12cd.xxxxxxxxxxxxxxxx
X-API-Key: vibevo_live_ab12cd.xxxxxxxxxxxxxxxx

Скоупы

Всего два права — по-отдельности функции не выбираются:

  • read — любой GET (кампании, офферы, аналитика, посты, креаторы, кошелёк, трекинг-ссылки, фабрики). Ключ получает read всегда.
  • write — любая запись (фабрики контента, подача видео).

Исключение: гостевой каталог размещений

Только GET /api/v1/creator-catalog и GET /api/v1/creator-pages/{publicId} работают без API-ключа. Эти маршруты возвращают опубликованную безопасную проекцию и не дают доступа к черновикам или операциям заказа.

Все операции участника идут под /api/v1/public/. Для чтения нужен scope read; для создания, изменения, загрузки и подтверждения действий нужен scope write. Core дополнительно проверяет роль, владельца аккаунта/канала и доступ к конкретному заказу. Write не даёт staff-доступ и не заменяет read.

Ошибки авторизации

  • 401 Unauthorized — ключ отсутствует, недействителен, истёк или отозван.
  • 403 Forbidden — ключ валиден, но у него нет скоупа, требуемого этим эндпоинтом.

Формат тела ошибки описан в справочнике эндпоинтов.

Была ли эта статья полезна?

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

Аутентификация в API VibeVO — API-ключи | VibeVO Docs