Оформление
Подключения Roistat, Phonix и Telegram
Через API управления можно получить список подключений и создать подключение в текущем проекте. Передавайте токен проекта в X-SN-TOKEN. Все пути ниже начинаются с /public/api/v1/manage/. Для POST передавайте Content-Type: application/json.
Найти проекты Roistat, доступные ключу
POST /roistat-integrations/projects/probe
Передайте ключ API пользователя в apiKey. Например:
json
{
"apiKey": "YOUR_ROISTAT_API_KEY"
}Например, 200 OK. Для подключения возьмите целочисленный roistatProjectId выбранного проекта из ответа. isOwner показывает, является ли пользователь владельцем этого проекта в Roistat.
json
{
"items": [
{
"roistatProjectId": 12345,
"name": "Demo shop",
"isOwner": true
}
],
"total": 1,
"returned": 1,
"hasMore": false
}Получить список подключений
Отправьте GET /roistat-integrations, GET /phonix-integrations или GET /telegram-integrations без тела и параметров query. Ответ содержит полный список подключений этого сервиса. total и returned равны, hasMore всегда false. Элементы содержат те же поля, что entity в примерах создания ниже.
Например, любой из трёх маршрутов вернёт такой 200 OK, если у сервиса нет подключений.
json
{
"items": [],
"total": 0,
"returned": 0,
"hasMore": false
}Подключить Roistat
POST /roistat-integrations
Передайте name, пользовательский apiKey и числовой roistatProjectId из проверки ключа. Права описаны в настройке Roistat.
Например, тело запроса:
json
{
"name": "Demo shop",
"apiKey": "YOUR_ROISTAT_API_KEY",
"roistatProjectId": 12345
}Например, ответ 200 OK:
json
{
"entity": {
"id": "c2ca7a99-4277-4b06-a678-49f8f6cc570a",
"name": "Demo shop",
"createdAtUtc": "2026-01-15T10:00:00Z",
"validationKind": "storedValidation",
"isCurrentTokenValid": true,
"lastSuccessfulAuthAtUtc": "2026-01-15T10:00:00Z",
"roistatProjectId": 12345,
"roistatProjectName": "Demo shop"
}
}Подключить Phonix
POST /phonix-integrations
Передайте name и accessToken рекламной интеграции без префикса Bearer. Подробнее в настройке Phonix.
Например, тело запроса:
json
{
"name": "Demo calls",
"accessToken": "YOUR_PHONIX_TOKEN"
}Например, ответ 200 OK:
json
{
"entity": {
"id": "4b59900c-9de8-44b4-996d-37d744ffcf74",
"name": "Demo calls",
"createdAtUtc": "2026-01-15T10:00:00Z",
"validationKind": "storedValidation",
"isCurrentTokenValid": true,
"lastSuccessfulAuthAtUtc": "2026-01-15T10:00:00Z"
}
}Подключить Telegram
POST /telegram-integrations
Передайте name и token для подписки на проект, например новый UUID. Необязательные логические поля agentChatEnabled, yandexDirectSetupAlertsEnabled и businessCommuniqueEnabled включают общение с ассистентом, сообщения о настройках Директа и сообщения из Потока. По умолчанию все три включены. Подключите чат отдельно по инструкции Telegram.
Например, тело запроса:
json
{
"name": "Demo team",
"token": "36d94970-92c9-44a1-88e1-63550cc75d28",
"agentChatEnabled": false
}Например, ответ 200 OK:
json
{
"entity": {
"id": "2a3ff855-dda2-4323-a745-bedf933b08dc",
"name": "Demo team",
"createdAtUtc": "2026-01-15T10:00:00Z",
"validationKind": "notChecked",
"subscriberCount": 0,
"agentChatEnabled": false,
"yandexDirectSetupAlertsEnabled": true,
"businessCommuniqueEnabled": true
}
}Как читать результат и исправлять ошибки
При успешном POST сохраните entity.id. Roistat и Phonix возвращают сохранённое состояние токена и время последней успешной авторизации, если оно известно. Telegram возвращает число подписчиков и выбранные настройки. Сразу после создания подписчиков ещё нет.
API использует формат ошибок управления. При 401 проверьте токен проекта. При ошибке валидации 400 проверьте обязательные поля и прочитайте code и hint, если они есть. Если не получили ответ на запрос создания, сначала запросите список подключений.