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

Работайте с шаблонами, юридическими профилями, документами и провайдерами КЭДО Битрикс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` | [Список юридических полей](./sign-b2e/list-legal-fields.md) | `sign.b2e.legal.field.list` |
| PATCH | `/v1/sign-b2e/legal-profiles/:userId` | [Изменить юридический профиль](./sign-b2e/update-legal-profile.md) | `sign.b2e.legal.profile.update` |
| GET | `/v1/sign-b2e/templates` | [Список шаблонов](./sign-b2e/list-templates.md) | `sign.b2e.template.list` |
| POST | `/v1/sign-b2e/templates/send` | [Отправить документ по шаблону](./sign-b2e/send-template.md) | `sign.b2e.template.send` |
| POST | `/v1/sign-b2e/template-folders/tail` | [Список комплектов шаблонов](./sign-b2e/tail-template-folders.md) | `sign.b2e.template.folder.tail` |
| GET | `/v1/sign-b2e/template-folders/:id` | [Получить комплект шаблонов](./sign-b2e/get-template-folder.md) | `sign.b2e.template.folder.get` |
| GET | `/v1/sign-b2e/documents/:uid` | [Получить документ](./sign-b2e/get-document.md) | `sign.b2e.document.get` |
| POST | `/v1/sign-b2e/documents/send` | [Отправить файл на подпись](./sign-b2e/send-document.md) | `sign.b2e.document.send` |
| GET | `/v1/sign-b2e/company-providers` | [Список провайдеров компании](./sign-b2e/list-company-providers.md) | `sign.b2e.company.provider.list` |
| GET | `/v1/sign-b2e/hcmlink/documents/:id` | [Получить документ КЭДО HCM Link](./sign-b2e/get-hcm-document.md) | `sign.b2e.hcmlink.document.get` |
| GET | `/v1/sign-b2e/personal-documents` | [Личные подписанные документы](./sign-b2e/list-personal-documents.md) | `sign.b2e.personal.tail` |
| GET | `/v1/sign-b2e/company-safe-documents` | [Документы в сейфе компании](./sign-b2e/list-safe-documents.md) | `sign.b2e.mysafe.tail` |
| GET | `/v1/sign-b2e/providers` | [Список внешних провайдеров](./sign-b2e/list-providers.md) | `sign.b2e.provider.tail` |
| POST | `/v1/sign-b2e/providers` | [Добавить внешнего провайдера](./sign-b2e/create-provider.md) | `sign.b2e.provider.add` |
| PATCH | `/v1/sign-b2e/providers/:id` | [Изменить внешнего провайдера](./sign-b2e/update-provider.md) | `sign.b2e.provider.update` |
| DELETE | `/v1/sign-b2e/providers/:id` | [Удалить внешнего провайдера](./sign-b2e/delete-provider.md) | `sign.b2e.provider.delete` |

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

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

```bash
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](/docs/errors).

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

- [Пользователи](/docs/entities/users)
- [Компании](/docs/entities/companies)
