К содержанию
sapportlydocs
Панель

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

Публичный API принимает ключ тенанта. Виджету — visitor JWT. Панели — отдельная сессия.

API-ключ

Authorization: Bearer sk_live_… на https://staging-api.sapportly.pro. Ключи создаются в панели, секрет показывается один раз.

bash
curl -sS https://staging-api.sapportly.pro/v1/conversations \
  -H "Authorization: Bearer $SAPPORTLY_API_KEY" \
  -H "Accept: application/json"

Права доступа

ПравоДля чего
messages:writeПриём входящих
conversations:readСписки диалогов, история и чтение identity/contact; чтение вебхуков — отдельное право
conversations:writeОтветы и запись identity/contact; запись вебхуков — отдельное право
conversations:assignНазначение и transfer
attachments:writeФайлы и запись в базу знаний
ws:connectТикет живого канала
channels:read|writeРеестр источников
widget:embed:issueBFF-сессия виджета
team:readРоли для assign по external_key
analytics:writeКастомные метрики

Visitor JWT

Заголовок X-Visitor-Token после bootstrap / embed-session. Нужен для сообщений виджета от имени посетителя. Подробнее: API виджета.

Панель

JWT на app.sapportly.pro. API-ключ эти маршруты не откроет — даже если URL похож на /v1/…. Не используйте @sapportly/api для новых интеграций: канон — Sapportly TypeScript SDK, пакет @sapportly/sdk (не @supportly/sdk: это имя на npm недоступно).

Страница полезна?

/docs/api/authentication
Аутентификация API — ключ тенанта и visitor JWT · Sapportly Docs