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

Подпись сотрудников

Работайте с шаблонами, юридическими профилями, документами и провайдерами КЭДО Битрикс24.

Скоуп: sign.b2e | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Что нужно знать

Ключи Company не поддерживаются. Используйте личный ключ или ключ приложения.

Скоуп не заменяет права пользователя. crm дополнительно нужен для шаблонов и комплектов, sign.b2e.document.get, sign.b2e.document.send и sign.b2e.company.provider.list. Для изменения юридического профиля нужен user.

humanresources.hcmlink нужен только для HCM-параметров sign.b2e.document.send и sign.b2e.company.provider.list. Чтение HCM-документа требует sign.b2e и OAuth-контекста администратора, без дополнительного HCM-скоупа.

Внешние провайдеры подписи, личные подписанные документы, сейф компании и документы HCM Link требуют OAuth. Для входящего вебхука эти семь операций возвращают 422 BITRIX_ERROR с нативным кодом WRONG_AUTH_TYPE в error.b24Code.

Для GET /v1/sign-b2e/company-providers нужен ключ READWRITE: ядро может регистрировать компанию у провайдера. READONLY отклоняется до вызова Битрикс24.

UID документа, UID шаблона, UID провайдера компании и числовой ID внешнего провайдера — разные идентификаторы. Отправка имеет юридические последствия; автоматических повторов нет. Ответы со ссылками с учётными данными редактируются, а пути замен доступны в meta.redacted. Такие ответы нельзя использовать как исходную конфигурацию для обратной записи.

Справочник эндпоинтов

Метод Путь Описание Bitrix24 метод
МетодGET Путь/v1/sign-b2e/legal-fields ОписаниеСписок юридических полей Bitrix24 методsign.b2e.legal.field.list
МетодPATCH Путь/v1/sign-b2e/legal-profiles/:userId ОписаниеИзменить юридический профиль Bitrix24 методsign.b2e.legal.profile.update
МетодGET Путь/v1/sign-b2e/templates ОписаниеСписок шаблонов Bitrix24 методsign.b2e.template.list
МетодPOST Путь/v1/sign-b2e/templates/send ОписаниеОтправить документ по шаблону Bitrix24 методsign.b2e.template.send
МетодPOST Путь/v1/sign-b2e/template-folders/tail ОписаниеСписок комплектов шаблонов Bitrix24 методsign.b2e.template.folder.tail
МетодGET Путь/v1/sign-b2e/template-folders/:id ОписаниеПолучить комплект шаблонов Bitrix24 методsign.b2e.template.folder.get
МетодGET Путь/v1/sign-b2e/documents/:uid ОписаниеПолучить документ Bitrix24 методsign.b2e.document.get
МетодPOST Путь/v1/sign-b2e/documents/send ОписаниеОтправить файл на подпись Bitrix24 методsign.b2e.document.send
МетодGET Путь/v1/sign-b2e/company-providers ОписаниеСписок провайдеров компании Bitrix24 методsign.b2e.company.provider.list
МетодGET Путь/v1/sign-b2e/hcmlink/documents/:id ОписаниеПолучить документ КЭДО HCM Link Bitrix24 методsign.b2e.hcmlink.document.get
МетодGET Путь/v1/sign-b2e/personal-documents ОписаниеЛичные подписанные документы Bitrix24 методsign.b2e.personal.tail
МетодGET Путь/v1/sign-b2e/company-safe-documents ОписаниеДокументы в сейфе компании Bitrix24 методsign.b2e.mysafe.tail
МетодGET Путь/v1/sign-b2e/providers ОписаниеСписок внешних провайдеров Bitrix24 методsign.b2e.provider.tail
МетодPOST Путь/v1/sign-b2e/providers ОписаниеДобавить внешнего провайдера Bitrix24 методsign.b2e.provider.add
МетодPATCH Путь/v1/sign-b2e/providers/:id ОписаниеИзменить внешнего провайдера Bitrix24 методsign.b2e.provider.update
МетодDELETE Путь/v1/sign-b2e/providers/:id ОписаниеУдалить внешнего провайдера Bitrix24 методsign.b2e.provider.delete

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

Получите доступные шаблоны:

Terminal
curl 'https://vibecode.bitrix24.tech/v1/sign-b2e/templates?limit=2' \
  -H 'X-Api-Key: YOUR_API_KEY'

Полный пример

Прочитайте первую страницу комплектов и затем сведения о первом найденном комплекте. Ключу нужны sign.b2e и crm.

javascript
const base = 'https://vibecode.bitrix24.tech/v1/sign-b2e';
const headers = { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' };
const pageResponse = await fetch(base + '/template-folders/tail', { method: 'POST', headers, body: '{}' });
const page = await pageResponse.json();
if (!pageResponse.ok || !page.success) throw new Error(page.error?.message);
if (page.data.length) {
  const response = await fetch(base + '/template-folders/' + encodeURIComponent(page.data[0].id), { headers });
  const bundle = await response.json();
  if (!response.ok || !bundle.success) throw new Error(bundle.error?.message);
  console.log(bundle.data);
}
console.log(page.meta.hasMore, page.meta.cursor);

Коды ошибок

Код Причина
КодSCOPE_DENIED ПричинаКлючу не выдан необходимый скоуп.
КодMETHOD_NOT_YET_AVAILABLE ПричинаДля шести операций шаблонов и юридических профилей нужен sign 26.1300.0; выпуск указан в error.release. Классические методы без этой отметки.
КодSIGN_B2E_TEMPLATE_FOLDER_NOT_FOUND ПричинаКомплект отсутствует или недоступен для отправки. Нативный код сохраняется в error.code и error.b24Code.
КодENTITY_NOT_FOUND ПричинаБитрикс24 вернул общий отказ NOT_FOUND. Нативный код передаётся в error.b24Code.

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

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