Для AI-агентов: markdown этой страницы — /docs-content/applications/connectors/list.md индекс документации — /llms.txt

Список коннекторов приложения

GET /v1/applications/:id/connectors

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

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеID карточки приложения. Получить: GET /v1/applications

Примеры

curl — личный ключ

Terminal
curl https://vibecode.bitrix24.tech/v1/applications/APPLICATION_ID/connectors \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal
curl https://vibecode.bitrix24.tech/v1/applications/APPLICATION_ID/connectors \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/applications/APPLICATION_ID/connectors', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(data.map((connector) => `${connector.slug}: ${connector.appState}`))

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/applications/APPLICATION_ID/connectors', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
console.log(data.map((connector) => `${connector.slug}: ${connector.appState}`))

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеКоннекторы компании
Полеdata[].slug Типstring ОписаниеКод коннектора. Нужен для заявки на доступ
Полеdata[].title Типstring ОписаниеНазвание коннектора
Полеdata[].iconUrl Типstring / null ОписаниеАдрес иконки; null у коннектора из каталога компании
Полеdata[].appState Типstring ОписаниеСостояние доступа приложения: DISABLED_ON_PORTAL, NOT_CONNECTED, CONNECTION_BROKEN, NO_GRANT, GRANT_PENDING, GRANT_DENIED, GRANT_REVOKED, EXPOSURE_WIDENED или AVAILABLE
Полеdata[].readTools Типarray ОписаниеИнструменты чтения коннектора
Полеdata[].readTools[].name Типstring ОписаниеИмя инструмента
Полеdata[].readTools[].title Типstring ОписаниеНазвание инструмента
Полеdata[].readTools[].description Типstring ОписаниеОписание инструмента
Полеdata[].readTools[].inputSchema Типobject ОписаниеJSON Schema аргументов инструмента
Полеdata[].exposure.linkAccess Типstring ОписаниеТекущая открытость приложения по ссылке: OFF, VIBECODE_AUTH, PUBLIC
Полеdata[].exposure.externalApiEnabled Типboolean ОписаниеВключён ли внешний API приложения

Пример ответа

JSON
{
  "success": true,
  "data": [
    {
      "slug": "orders",
      "title": "Orders",
      "iconUrl": "https://vibecode.bitrix24.tech/api/connectors/orders/icon",
      "appState": "GRANT_PENDING",
      "readTools": [],
      "exposure": {
        "linkAccess": "OFF",
        "externalApiEnabled": false
      }
    }
  ]
}

Пример ответа при ошибке

404 — приложения нет, у вызывающего нет права им управлять или коннекторы для приложений выключены для портала:

JSON
{
  "success": false,
  "error": {
    "code": "APPLICATION_NOT_FOUND",
    "message": "APPLICATION_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодAPPLICATION_NOT_FOUND ОписаниеПриложения нет, оно недоступно, находится на другой машине, чем ключ, или коннекторы для приложений выключены для портала
HTTP403 КодEXTERNAL_COLLABORATOR_KEY_SERVER_MISMATCH ОписаниеКлюч внешнего участника разработки и приложение не привязаны к одной машине
HTTP403 КодEXTERNAL_COLLABORATOR_NOT_A_MEMBER ОписаниеУчастие внешнего разработчика отозвано или истекло
HTTP403 КодPORTAL_COLLABORATOR_NOT_A_MEMBER ОписаниеПользователь больше не входит в команду разработки машины
HTTP401 КодINVALID_API_KEY ОписаниеНеверный ключ
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key

Полный список общих ошибок API — Ошибки.

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