#Менеджмент-ключи

Менеджмент-ключи (vibe_live_) не привязаны к одному порталу и предназначены для автоматизации администрирования: управления API-ключами, просмотра порталов и работы с обратной связью.

#Отличие от ключей портала

#Скоупы менеджмент-ключа

Каждый менеджмент-ключ создаётся с одним или несколькими скоупами. Без нужного скоупа конкретный эндпоинт возвращает 403 MANAGEMENT_SCOPE_REQUIRED — даже если эндпоинт в принципе доступен менеджмент-ключам.

Эндпоинты /v1/me, /v1/guide и /v1/openapi.json доступны любому менеджмент-ключу без отдельного скоупа.

При создании ключа выбирайте только нужные скоупы — если ключ предназначен только для управления API-ключами, скоуп vibe:mgmt:feedback ему не нужен.

#Доступные эндпоинты

При обращении к эндпоинтам сущностей Битрикс24 возвращается 403 MANAGEMENT_KEY_NO_ENTITY_ACCESS.

#`GET /v1/me` — самоописание ключа

Возвращает тип ключа, список порталов с ролями и количеством ключей, перечень доступных эндпоинтов и быстрый старт.

curl -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/me

Ответ:

{
  "success": true,
  "data": {
    "type": "management",
    "keyPrefix": "vibe_live_abc123",
    "keySuffix": "f9d2",
    "expiresAt": null,
    "scopes": [],
    "capabilities": [
      "GET https://vibecode.bitrix24.tech/v1/me — this endpoint (management key self-description)",
      "GET https://vibecode.bitrix24.tech/v1/guide — full API reference (portal-agnostic)",
      "GET https://vibecode.bitrix24.tech/v1/keys — list APP keys for a portal (requires portalId query param)",
      "POST https://vibecode.bitrix24.tech/v1/keys — create APP key (requires portalId in body)",
      "GET https://vibecode.bitrix24.tech/v1/portals — list your portals",
      "GET https://vibecode.bitrix24.tech/v1/feedback — list ALL platform feedback (management key sees everything)",
      "GET https://vibecode.bitrix24.tech/v1/feedback/:id — feedback details including comment thread",
      "PATCH https://vibecode.bitrix24.tech/v1/feedback/:id — update status/resolution (legacy, prefer /comments)",
      "POST https://vibecode.bitrix24.tech/v1/feedback/:id/comments — post a team comment, changes status"
    ],
    "portals": [
      {
        "id": "portal-uuid",
        "domain": "mycompany.bitrix24.ru",
        "status": "ACTIVE",
        "role": "ADMIN",
        "appKeyCount": 3
      }
    ],
    "totalAppKeys": 3,
    "quickstart": {
      "step1": "GET https://vibecode.bitrix24.tech/v1/portals — list available portals",
      "step2": "GET https://vibecode.bitrix24.tech/v1/keys?portalId=<id> — list APP keys for a portal",
      "step3": "POST https://vibecode.bitrix24.tech/v1/keys { portalId, name, scopes } — create an APP key",
      "step4": "Use the APP key for entity API calls (deals, tasks, etc.)"
    },
    "docs": "https://vibecode.bitrix24.tech/docs/management-keys"
  }
}

В ответе также присутствует объект feedback со справочником эндпоинтов, статусов и фильтров для работы с тикетами обратной связи — он используется AI-моделями для автоматической обработки тикетов.

#`GET /v1/guide` — справочник API

Возвращает полный справочник API со всеми сущностями (без фильтрации по скоупам). Используется для подбора нужных эндпоинтов перед созданием API-ключей.

curl -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/guide

#`GET /v1/openapi.json` — OpenAPI-спецификация

Возвращает машинно-читаемую OpenAPI 3.1 спецификацию платформы Вайбкод.

curl -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/openapi.json

#`GET /v1/portals` — список порталов

Возвращает порталы, к которым пользователь имеет доступ, с ролью на каждом портале.

curl -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/portals

#`GET /v1/keys` — список API-ключей портала

Параметр portalId обязателен.

curl -H "X-Api-Key: vibe_live_abc123..." \
  "https://vibecode.bitrix24.tech/v1/keys?portalId=portal-uuid"

#`POST /v1/keys` — создание API-ключа

Создаёт новый API-ключ (vibe_api_) для указанного портала. В теле передаётся portalId, имя и список скоупов. Полный ключ возвращается в поле rawKey один раз — сохраните его сразу.

curl -X POST \
  -H "X-Api-Key: vibe_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"portalId": "portal-uuid", "name": "My Key", "scopes": ["crm", "task"]}' \
  https://vibecode.bitrix24.tech/v1/keys

Дополнительные коды ошибок:

#`GET /v1/keys/:id` — данные одного ключа

Возвращает данные ключа без секрета (только префикс, имя, скоупы, статус).

curl -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/keys/key-uuid

#`PATCH /v1/keys/:id` — обновление ключа

Можно изменить любое из полей ниже (все необязательны, передавайте только то, что меняете):

curl -X PATCH \
  -H "X-Api-Key: vibe_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"status": "REVOKED"}' \
  https://vibecode.bitrix24.tech/v1/keys/key-uuid

#`DELETE /v1/keys/:id` — удаление ключа

Удаляет ключ. Если на ключе есть активные серверы, возвращается 409 KEY_HAS_ACTIVE_SERVERS — серверы нужно удалить первыми.

curl -X DELETE \
  -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/keys/key-uuid

#`POST /v1/keys/:id/rotate` — перевыпуск ключа

Создаёт новый ключ с теми же настройками и оставляет старому переходный период 24 часа. После перевыпуска старый ключ автоматически становится недействительным.

curl -X POST \
  -H "X-Api-Key: vibe_live_abc123..." \
  https://vibecode.bitrix24.tech/v1/keys/key-uuid/rotate

#`GET /v1/feedback` — список тикетов обратной связи

Возвращает все тикеты обратной связи на платформе. Поддерживает фильтры по статусу, категории, порталу и постраничную выборку.

curl -H "X-Api-Key: vibe_live_abc123..." \
  "https://vibecode.bitrix24.tech/v1/feedback?status=NEW&page=1&limit=50"

#`GET /v1/feedback/:id` — карточка тикета

Возвращает тикет со всем тредом комментариев.

#`PATCH /v1/feedback/:id` — обновление тикета

Меняет статус и резолюцию тикета.

#`POST /v1/feedback/:id/comments` — комментарий к тикету

Добавляет команду в тред и одновременно меняет статус. Используется AI-моделями для ответа пользователю.

#Статусы тикетов

#Категории тикетов

BUG, SUGGESTION, DOCS, CHAT, BOTS, OTHER.

#Фильтры списка

?status=NEW&category=BUG&portalId=<uuid>&page=1&limit=50. Параметр limit ограничен значением 100.

#Быстрый старт

1. Создайте менеджмент-ключ в личном кабинете (раздел «Менеджмент-ключи»)
2. Получите список порталов: GET /v1/portals
3. Посмотрите существующие ключи на нужном портале: GET /v1/keys?portalId=<id>
4. Создайте API-ключ с нужными скоупами: POST /v1/keys { portalId, name, scopes }
5. Используйте полученный API-ключ (vibe_api_…) для работы с данными Битрикс24

#Ограничения

• Менеджмент-ключи не могут обращаться к эндпоинтам сущностей Битрикс24 (/v1/deals, /v1/tasks и другим)
• Для работы с данными используйте API-ключ (vibe_api_) или ключ авторизации (vibe_app_)
• При попытке обратиться к неподдерживаемому эндпоинту возвращается 403 MANAGEMENT_KEY_NO_ENTITY_ACCESS

#Смотрите также

• Ключи и авторизация — создание ключа, типы, передача, лимиты, IP, жизненный цикл, безопасность
• Скоупы — справочник скоупов и как их выбрать
• Быстрый старт — первый запрос за 2 минуты
• Оптимизация и batch — ускорение в 50 раз через POST /v1/batch
• Коды ошибок — справочник ошибок API