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

`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-приложение

```bash
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<string> | Присутствует при скрытии учётных данных; содержит пути изменённых значений. |

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

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

```json
{
  "success": true,
  "data": {
    "id": 7
  }
}
```

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

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

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

## Ошибки

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

[Общие ошибки API](/docs/errors).

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

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

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

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

- [Подпись сотрудников](/docs/sign-b2e)
- [Ошибки API](/docs/errors)
