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

Добавить внешнего провайдера

POST /v1/sign-b2e/providers

Регистрирует внешнего провайдера подписи. Вызвать может администратор через OAuth.

Скоупы: sign.b2e.

Доступен только ключу OAuth-приложения с пользовательской сессией. Для входящего вебхука возвращается 422 BITRIX_ERROR с нативным кодом WRONG_AUTH_TYPE в error.b24Code.

Поля запроса (body)

Параметр Тип Обяз. Описание
Параметрfields Типobject Обяз.да ОписаниеДанные внешнего провайдера; значения передаются Битрикс24.
Параметрfields.title Типstring | null Обяз.нет ОписаниеНазвание провайдера. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.
Параметрfields.description Типstring | null Обяз.нет ОписаниеОписание провайдера. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.
Параметрfields.iconUri Типstring | null Обяз.нет ОписаниеURL значка провайдера. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.
Параметрfields.companyRegUri Типstring | null Обяз.нет ОписаниеURL регистрации компании; необязателен при создании. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.
Параметрfields.documentSignUri Типstring | null Обяз.нет ОписаниеURL подписания документа. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.
Параметрfields.publicKeyUri Типstring | null Обяз.нет ОписаниеURL открытого ключа провайдера. Поле допускает null; при изменении null и отсутствие сохраняют прежнее значение.

Примеры

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

Terminal
curl -X POST 'https://vibecode.bitrix24.tech/v1/sign-b2e/providers' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"title": "VIBE-PROBE", "description": "VIBE-PROBE test provider", "iconUri": "https://example.com/icon.png", "documentSignUri": "https://example.com/sign", "publicKeyUri": "https://example.com/public-key"}}'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/sign-b2e/providers', {
  "method": "POST",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"title": "VIBE-PROBE", "description": "VIBE-PROBE test provider", "iconUri": "https://example.com/icon.png", "documentSignUri": "https://example.com/sign", "publicKeyUri": "https://example.com/public-key"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеУспешность запроса.
Полеdata Типobject ОписаниеДанные операции.
Полеdata.id Типinteger ОписаниеИдентификатор объекта.
Полеmeta.redacted Типarray ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений.

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

Форма успешного ответа; данные зависят от портала и запроса.

JSON
{
  "success": true,
  "data": {
    "id": 7
  }
}

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

403 — ключу не выдан обязательный скоуп:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}

Ошибки

HTTP Код Причина
HTTP400 КодINVALID_PARAMS ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса.
HTTP401 КодTOKEN_MISSING ПричинаНет учётных данных соединения с Битрикс24.
HTTP403 КодSCOPE_DENIED ПричинаНе выдан один из обязательных скоупов.
HTTP422 КодBITRIX_ERROR ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message.
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ПричинаКлюч разрешает только чтение.
HTTP422 КодBITRIX_ERROR ПричинаВходящий вебхук вместо OAuth. Нативный код WRONG_AUTH_TYPE передаётся в error.b24Code.

Общие ошибки API.

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

Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.

Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале; повторный вызов может повторно выполнить операцию.

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