Добавить провайдера подписи sign.b2e.provider.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sign.b2e

Кто может выполнять метод: администратор

Метод sign.b2e.provider.add подключает к Битрикс24 внешний провайдер подписи.

Метод работает только в контексте авторизации приложения.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с полями нового провайдера. Описание полей

Параметр fields

Адреса передавайте полностью, со схемой http или https. Обязательные поля не могут быть пустой строкой.

Название
тип

Описание

title*
string

Название провайдера

description*
string

Краткое описание провайдера

iconUri*
string

Адрес иконки провайдера для интерфейса Битрикс24

companyRegUri
string

Адрес страницы, на которой компания регистрируется у провайдера

documentSignUri*
string

Адрес страницы подписания документа у провайдера

publicKeyUri*
string

Адрес публичного ключа провайдера. Ключом проверяется подпись документов

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"Test provider name","description":"Brief text about provider","iconUri":"https://provider.sign.com/bitrix/icon.png","companyRegUri":"https://provider.sign.com/bitrix/register/","documentSignUri":"https://provider.sign.com/bitrix/sign/","publicKeyUri":"https://provider.sign.com/bitrix/public.key"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.provider.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// On a sign service failure result holds error and error_description instead of the id
type ProviderAddResult = number | { error: number, error_description: string }

try {
  const response = await $b24.actions.v2.call.make<ProviderAddResult>({
    method: 'sign.b2e.provider.add',
    params: {
      fields: {
        title: 'Test provider name',
        description: 'Brief text about provider',
        iconUri: 'https://provider.sign.com/bitrix/icon.png',
        companyRegUri: 'https://provider.sign.com/bitrix/register/',
        documentSignUri: 'https://provider.sign.com/bitrix/sign/',
        publicKeyUri: 'https://provider.sign.com/bitrix/public.key',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    if (typeof result === 'number') {
      console.info('Provider id:', result)
    } else {
      console.error(result.error_description)
    }
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addSignProvider() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sign.b2e.provider.add',
        params: {
          fields: {
            title: 'Test provider name',
            description: 'Brief text about provider',
            iconUri: 'https://provider.sign.com/bitrix/icon.png',
            companyRegUri: 'https://provider.sign.com/bitrix/register/',
            documentSignUri: 'https://provider.sign.com/bitrix/sign/',
            publicKeyUri: 'https://provider.sign.com/bitrix/public.key'
          }
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      // On a sign service failure result holds error and error_description instead of the id
      const result = response.getData().result
      if (typeof result === 'number') {
        console.info('Provider id:', result)
      } else {
        console.error(result.error_description)
      }
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addSignProvider)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.call(
        "sign.b2e.provider.add",
        {
            "fields": {
                "title": "Test provider name",
                "description": "Brief text about provider",
                "iconUri": "https://provider.sign.com/bitrix/icon.png",
                "companyRegUri": "https://provider.sign.com/bitrix/register/",
                "documentSignUri": "https://provider.sign.com/bitrix/sign/",
                "publicKeyUri": "https://provider.sign.com/bitrix/public.key",
            },
        },
    ).response
    result = bitrix_response.result
    # При ошибке сервиса подписи result содержит error и error_description
    if isinstance(result, dict):
        print(f"Ошибка сервиса подписи: {result['error_description']}")
    else:
        print(f"Идентификатор провайдера: {result}")
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sign.b2e.provider.add',
            [
                'fields' => [
                    'title' => 'Test provider name',
                    'description' => 'Brief text about provider',
                    'iconUri' => 'https://provider.sign.com/bitrix/icon.png',
                    'companyRegUri' => 'https://provider.sign.com/bitrix/register/',
                    'documentSignUri' => 'https://provider.sign.com/bitrix/sign/',
                    'publicKeyUri' => 'https://provider.sign.com/bitrix/public.key'
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
    'sign.b2e.provider.add',
    {
        fields: {
            title: 'Test provider name',
            description: 'Brief text about provider',
            iconUri: 'https://provider.sign.com/bitrix/icon.png',
            companyRegUri: 'https://provider.sign.com/bitrix/register/',
            documentSignUri: 'https://provider.sign.com/bitrix/sign/',
            publicKeyUri: 'https://provider.sign.com/bitrix/public.key'
        }
    },
    result => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.dir(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'sign.b2e.provider.add',
    [
        'fields' => [
            'title' => 'Test provider name',
            'description' => 'Brief text about provider',
            'iconUri' => 'https://provider.sign.com/bitrix/icon.png',
            'companyRegUri' => 'https://provider.sign.com/bitrix/register/',
            'documentSignUri' => 'https://provider.sign.com/bitrix/sign/',
            'publicKeyUri' => 'https://provider.sign.com/bitrix/public.key'
        ]
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} elseif (is_array($result['result'])) {
    echo 'Ошибка сервиса подписи: ' . $result['result']['error_description'];
} else {
    echo 'Идентификатор провайдера: ' . $result['result'];
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sign.b2e.provider.add", b24.Params{
	"fields": b24.Params{
		"title":           "Test provider name",
		"description":     "Brief text about provider",
		"iconUri":         "https://provider.sign.com/bitrix/icon.png",
		"companyRegUri":   "https://provider.sign.com/bitrix/register/",
		"documentSignUri": "https://provider.sign.com/bitrix/sign/",
		"publicKeyUri":    "https://provider.sign.com/bitrix/public.key",
	},
})
if err != nil {
	return fmt.Errorf("sign.b2e.provider.add: %w", err)
}

var id int
if err := json.Unmarshal(res.Result, &id); err != nil {
	// при ошибке сервиса подписи result содержит error и error_description
	return fmt.Errorf("ответ сервиса подписи: %s", res.Result)
}
fmt.Println("идентификатор провайдера:", id)

Обработка ответа

HTTP-статус: 200

{
    "result": 41,
    "time": {
        "start": 1792738603,
        "finish": 1792738603.104434,
        "duration": 0.10443401336669922,
        "processing": 0,
        "date_start": "2026-10-23T09:56:43+03:00",
        "date_finish": "2026-10-23T09:56:43+03:00",
        "operating_reset_at": 1792739160,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
integer

Идентификатор добавленного провайдера. Нужен для методов sign.b2e.provider.update и sign.b2e.provider.delete

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method Application context required"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Ошибки сервиса подписи Битрикс24 приходят с HTTP-статусом 200 в одном из двух видов.

Если у ошибки есть код, ответ содержит error и error_description на верхнем уровне, как обычная ошибка метода. Так приходят ошибки проверки адресов и названия:

{
    "error": 100,
    "error_description": "PublicKeyUri must be valid",
    "ex": {
        "status": 200,
        "ex": 100
    }
}

Если кода нет, в result вместо идентификатора приходит объект с полями error и error_description. Проверяйте тип result перед тем, как использовать значение как идентификатор:

{
    "result": {
        "error": 0,
        "error_description": "Не заполнено обязательное поле \"Description\""
    },
    "time": {...}
}

Если в тексте ошибки указан код SIGN_CLIENT_CONNECTION_ERROR, INCORRECT_JSON, INCORRECT_HTTP_STATUS, INCORRECT_DATA или INCORRECT_REGISTER_RESPONSE, Битрикс24 не получил ответ сервиса. Провайдер при этом мог быть добавлен. Перед повторным вызовом проверьте список провайдеров методом sign.b2e.provider.tail.

Возможные коды ошибок

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Метод вызван не из приложения с OAuth-авторизацией, например через вебхук

403

ACCESS_DENIED

Access denied! Access denied

Пользователь не администратор или КЭДО недоступен на Битрикс24

403

ACCESS_DENIED

Access denied! User authorization required

Запрос выполнен без авторизации пользователя

200

100

Title must be provided

В поле title передана пустая строка

200

100

IconUri must be valid

Поле iconUri содержит адрес не со схемой http или https

200

100

CompanyRegUri must be empty be valid

Поле companyRegUri содержит адрес не со схемой http или https

200

100

DocumentSignUri must be valid

Поле documentSignUri содержит адрес не со схемой http или https

200

100

PublicKeyUri must be valid

Поле publicKeyUri содержит адрес не со схемой http или https

200

0 в result.error

Не удалось выполнить действие, попробуйте чуть позже (код ошибки: 100)

Не передано обязательное поле: title, description, iconUri, documentSignUri или publicKeyUri

200

0 в result.error

Не заполнено обязательное поле "Description"

В поле description передана пустая строка

200

0 в result.error

Не удалось выполнить действие, попробуйте чуть позже (код ошибки: #CODE#)

Сервис подписи вернул ошибку или Битрикс24 не получил его ответ. Вместо #CODE# указан код причины. Текст приходит на языке пользователя

200

0 в result.error

Действие пока недоступно, попробуйте чуть позже

Версия сервиса подписи еще не поддерживает это действие

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение