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

Запросить доступ к коннектору

POST /v1/applications/:id/connectors/:slug/access-request

Отправляет администратору портала заявку на доступ приложения к коннектору компании и возвращает коннектор с текущим состоянием доступа. Тело запроса не требуется.

Параметры

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

Примеры

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

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

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

Terminal
curl -X POST https://vibecode.bitrix24.tech/v1/applications/APPLICATION_ID/connectors/orders/access-request \
  -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/orders/access-request', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('State:', data.appState)

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

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

const { success, data } = await res.json()
console.log('State:', data.appState)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Поле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 ОписаниеИнструменты чтения коннектора: name, title, description, inputSchema — как в списке коннекторов
Поле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": "CONNECTOR_NOT_FOUND",
    "message": "CONNECTOR_NOT_FOUND"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодCONNECTOR_NOT_FOUND ОписаниеКоннектор недоступен или не поддерживает подключение компании
HTTP404 КодAPPLICATION_NOT_FOUND ОписаниеПриложения нет, оно недоступно, находится на другой машине, чем ключ, или коннекторы для приложений выключены для портала
HTTP413 КодFST_ERR_CTP_BODY_TOO_LARGE ОписаниеТело запроса больше 1 КиБ
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме READONLY
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 — Ошибки.

Известные особенности

  • Повторная заявка. Пока заявка ждёт решения или доступ действует, повторный вызов не создаёт новую заявку и не отправляет администратору повторное уведомление. Отклонённую или отозванную заявку можно подать заново.
  • Заявка не даёт доступа. Доступ появляется только после одобрения администратором. До одобрения администратор подключает компанию к коннектору, и пока она не подключена, appState после заявки может оставаться NOT_CONNECTED.

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