Получить список провайдеров подписи sign.b2e.provider.tail
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
sign.b2eКто может выполнять метод: администратор
Метод sign.b2e.provider.tail возвращает список внешних провайдеров подписи, подключенных к Битрикс24.
Метод работает только в контексте авторизации приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
limit |
Количество записей на странице. Параметр принимает значение от 1 до 1000. Если значение вне диапазона, метод использует значение по умолчанию. По умолчанию 20 |
|
offset |
Сколько записей пропустить от начала списка. Используется для постраничной навигации вместе с По умолчанию 0 |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"limit":10,"offset":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.provider.tail
// 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
type ProviderItem = {
id: number
title: string
description: string
iconUri: string
companyRegUri: string
documentSignUri: string
publicKeyUri: string
}
// On a sign service failure result holds error and error_description instead of the list
type ProviderTailResult = ProviderItem[] | { error: number, error_description: string }
try {
// The method pages with limit and offset, not with start,
// so the SDK list helpers do not apply: request the next page with a new offset
const response = await $b24.actions.v2.call.make<ProviderTailResult>({
method: 'sign.b2e.provider.tail',
params: {
limit: 10,
offset: 0,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
if (Array.isArray(result)) {
result.forEach(provider => console.info(provider.id, provider.title))
} 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 fetchSignProviders() {
try {
const $b24 = await B24Js.initializeB24Frame()
// The method pages with limit and offset, not with start,
// so the SDK list helpers do not apply: request the next page with a new offset
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.provider.tail',
params: {
limit: 10,
offset: 0
},
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 list
const result = response.getData().result
if (Array.isArray(result)) {
result.forEach(provider => console.info(provider.id, provider.title))
} else {
console.error(result.error_description)
}
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSignProviders)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.call(
"sign.b2e.provider.tail",
{
"limit": 10,
"offset": 0,
},
).response
result = bitrix_response.result
# При ошибке сервиса подписи result содержит error и error_description
if isinstance(result, dict):
print(f"Ошибка сервиса подписи: {result['error_description']}")
else:
for provider in result:
print(provider["id"], provider["title"])
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.tail',
[
'limit' => 10,
'offset' => 0
]
);
$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.tail',
{
limit: 10,
offset: 0
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sign.b2e.provider.tail',
[
'limit' => 10,
'offset' => 0
]
);
if (isset($result['error'])) {
echo 'Ошибка: ' . $result['error_description'];
} elseif (isset($result['result']['error_description'])) {
echo 'Ошибка сервиса подписи: ' . $result['result']['error_description'];
} else {
echo '<PRE>';
print_r($result['result']);
echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sign.b2e.provider.tail", b24.Params{
"limit": 10,
"offset": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sign.b2e.provider.tail: %w", err)
}
var items []struct {
ID int `json:"id"`
Title string `json:"title"`
Description string `json:"description"`
IconURI string `json:"iconUri"`
CompanyRegURI string `json:"companyRegUri"`
DocumentSignURI string `json:"documentSignUri"`
PublicKeyURI string `json:"publicKeyUri"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
// при ошибке сервиса подписи result содержит error и error_description
return fmt.Errorf("ответ сервиса подписи: %s", res.Result)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": 41,
"title": "Docs check provider",
"description": "Provider for documentation check",
"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"
},
{
"id": 43,
"title": "Docs check provider",
"description": "Provider for documentation check",
"iconUri": "https://provider.sign.com/bitrix/icon.png",
"companyRegUri": "",
"documentSignUri": "https://provider.sign.com/bitrix/sign/",
"publicKeyUri": "https://provider.sign.com/bitrix/public.key"
}
],
"time": {
"start": 1792738605,
"finish": 1792738605.693056,
"duration": 0.6930561065673828,
"processing": 0,
"date_start": "2026-10-23T09:56:45+03:00",
"date_finish": "2026-10-23T09:56:45+03:00",
"operating_reset_at": 1792739160,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список внешних провайдеров подписи (подробное описание). Удаленные провайдеры в список не попадают. Если провайдеров нет, возвращается пустой массив |
|
time |
Информация о времени выполнения запроса |
Элемент массива result
|
Название |
Описание |
|
id |
Идентификатор провайдера |
|
title |
Название провайдера |
|
description |
Краткое описание провайдера |
|
iconUri |
Адрес иконки провайдера для интерфейса Битрикс24 |
|
companyRegUri |
Адрес страницы, на которой компания регистрируется у провайдера. Если адрес не задан, возвращается пустая строка |
|
documentSignUri |
Адрес страницы подписания документа у провайдера |
|
publicKeyUri |
Адрес публичного ключа провайдера. Ключом проверяется подпись документов |
Обработка ошибок
HTTP-статус: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Current authorization type is denied for this method Application context required"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Если сервис подписи Битрикс24 вернул ошибку без собственного кода, метод отвечает с HTTP-статусом 200, а в result вместо массива приходит объект с полями error и error_description. Проверяйте, что result — массив, перед тем как перебирать провайдеров.
{
"result": {
"error": 0,
"error_description": "Не удалось выполнить действие, попробуйте чуть позже (код ошибки: SIGN_CLIENT_CONNECTION_ERROR)"
},
"time": {...}
}
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Current authorization type is denied for this method Application context required |
Метод вызван не из приложения с OAuth-авторизацией, например через вебхук |
|
|
|
Access denied! Access denied |
Пользователь не администратор или КЭДО недоступен на Битрикс24 |
|
|
|
Access denied! User authorization required |
Запрос выполнен без авторизации пользователя |
|
|
Код сервиса подписи |
Текст ошибки сервиса подписи |
Сервис подписи не получил список и вернул собственный код ошибки |
|
|
|
Не удалось выполнить действие, попробуйте чуть позже (код ошибки: #CODE#) |
Сервис подписи вернул ошибку или Битрикс24 не получил его ответ. Вместо |
|
|
|
Действие пока недоступно, попробуйте чуть позже |
Версия сервиса подписи еще не поддерживает это действие |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |