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

Менеджмент-ключи (vibe_live_) — кроссплатформенные ключи для управления API-ключами и порталами. Они не привязаны к конкретному порталу и позволяют автоматизировать администрирование.

#Отличие от API-ключей

Возможность API-ключ (vibe_api_) Менеджмент-ключ (vibe_live_)
Привязка к порталу Да (один портал) Нет (все порталы пользователя)
Доступ к сущностям (deals, tasks) Да Нет
Управление ключами Нет Да
Просмотр порталов Нет Да
Справочник API Фильтрован по скоупам Полный (все сущности)

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

#`GET /v1/me` — Информация о ключе

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

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

Ответ:

JSON 
{
  "success": true,
  "data": {
    "type": "management",
    "portals": [
      {
        "id": "portal-uuid",
        "domain": "mycompany.bitrix24.ru",
        "status": "ACTIVE",
        "role": "ADMIN",
        "appKeyCount": 3
      }
    ],
    "totalAppKeys": 3,
    "capabilities": ["/v1/me", "/v1/guide", "/v1/keys", "/v1/portals"]
  }
}

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

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

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

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

Требует portalId в query-параметрах.

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

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

Требует portalId в теле запроса.

Terminal 
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/portals` — Список порталов

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

#Quickstart

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

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

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