VARICA
digital proposal bureau
VARICA / Документация v2

Авторизация v2

Какие заголовки нужны для внешних и административных запросов, где использовать X-Api-Key, а где X-Admin-Token.

МетодGUIDE Endpointv2 auth АвторизацияСправка Вход- ВыходHTML
01 / Раздел

Два контура доступа

В v2 сейчас используются два независимых контура авторизации: внешний и административный.

Внешний контур нужен для интеграций клиента, которые создают страницы и передают бизнес-данные. Административный контур нужен для настройки пространства и служебных тестов.

02 / Раздел

X-Api-Key

  • Используется для внешних интеграций.
  • Передаётся в HTTP-заголовке `X-Api-Key`.
  • Привязан к конкретной организации.
  • Подходит для методов создания страниц и фиксации результата по сущности.
Пример
curl -X POST "http://varica.ru/api/v2/pages" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -F "template_id=54" \
  -F "source_entity_id=9999999"
03 / Раздел

X-Admin-Token

  • Используется для административных методов.
  • Передаётся в HTTP-заголовке `X-Admin-Token`.
  • Нужен для чтения и сохранения настроек Sensei, получения списка процессов и тестовой отправки события открытия.
Пример
curl -X GET "http://varica.ru/api/v2/sensei/config" \
  -H "X-Admin-Token: YOUR_ADMIN_TOKEN"
04 / Раздел

Матрица по текущим методам

  • `POST /api/v2/pages` -> `X-Api-Key`
  • `POST /api/v2/entity-results` -> `X-Api-Key`
  • `GET /api/v2/sensei/config` -> `X-Admin-Token`
  • `PATCH /api/v2/sensei/config` -> `X-Admin-Token`
  • `GET /api/v2/sensei/processes` -> `X-Admin-Token`
  • `POST /api/v2/sensei/test-open` -> `X-Admin-Token`
05 / Раздел

Для ИИ и интегратора

Краткая инструкция
Если метод работает с бизнес-данными клиента и создаёт/обновляет результат, используй X-Api-Key.
Если метод связан с настройкой пространства или служебной проверкой интеграции, используй X-Admin-Token.