Создать коннектор biconnector.connector.add
Scope:
biconnectorКто может выполнять метод: пользователь с доступом к разделу «Рабочее место аналитика»
Метод biconnector.connector.add создает новый коннектор, который позволяет интегрировать внешние источники данных в Битрикс24.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект, содержащий данные для создания нового коннектора. Формат объекта:
|
Параметр fields
|
Название |
Описание |
|
title* |
Название коннектора |
|
logo* |
Логотип коннектора. Может передаваться ссылкой на изображение или строкой формата base64, например |
|
description |
Описание коннектора |
|
urlCheck* |
Эндпоинт коннектора для проверки доступности, (подробное описание) |
|
urlTableList* |
Эндпоинт коннектора для получения списка таблиц, (подробное описание) |
|
urlTableDescription* |
Эндпоинт коннектора для получения описания конкретной таблицы, (подробное описание) |
|
urlData* |
Эндпоинт коннектора для получения данных по выбранной таблице, (подробное описание) |
|
settings* |
Список параметров подключения, (подробное описание) |
|
sort |
Параметр сортировки коннекторов. Значение по умолчанию |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Логин",
"type": "STRING",
"code": "login"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 100
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Логин",
"type": "STRING",
"code": "login"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 100
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.connector.add
try
{
const response = await $b24.callMethod(
'biconnector.connector.add',
{
fields: {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Логин",
"type": "STRING",
"code": "login"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 100
},
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result.data());
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'biconnector.connector.add',
[
'fields' => [
"title" => "SUPER REST CONNECTOR",
"logo" => "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description" => "Connector with token",
"urlCheck" => "http://example.com/api/check",
"urlTableList" => "http://example.com/api/table_list",
"urlTableDescription" => "http://example.com/api/table_description",
"urlData" => "http://example.com/api/data",
"settings" => [
[
"name" => "Логин",
"type" => "STRING",
"code" => "login"
],
[
"name" => "Пароль",
"type" => "STRING",
"code" => "password"
]
],
"sort" => 100
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding connector: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.connector.add',
{
fields: {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Логин",
"type": "STRING",
"code": "login"
},
{
"name": "Пароль",
"type": "STRING",
"code": "password"
}
],
"sort": 100
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
},
);
require_once('crest.php');
$result = CRest::call(
'biconnector.connector.add',
[
'fields' => [
'title' => 'SUPER REST CONNECTOR',
'logo' => 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==',
'description' => 'Connector with token',
'urlCheck' => 'http://example.com/api/check',
'urlTableList' => 'http://example.com/api/table_list',
'urlTableDescription' => 'http://example.com/api/table_description',
'urlData' => 'http://example.com/api/data',
'settings' => [
[
'name' => 'Логин',
'type' => 'STRING',
'code' => 'login'
],
[
'name' => 'Пароль',
'type' => 'STRING',
'code' => 'password'
]
],
'sort' => 100
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": 4
},
"time": {
"start": 1725013197.635808,
"finish": 1725013198.580873,
"duration": 0.9450650215148926,
"processing": 0.6822988986968994,
"date_start": "2024-08-30T12:19:57+02:00",
"date_finish": "2024-08-30T12:19:58+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит идентификатор созданного коннектора |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 200
{
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Fields not provided |
Поля не переданы в запросе |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Обнаружены неизвестные параметры: перечень |
|
|
Field "#TITLE#" is required. |
Обязательное поле #TITLE# не передано |
|
|
Field "#TITLE#" is read only. |
Поле #TITLE# доступно только для чтения и не может быть изменено |
|
|
Field "#TITLE#" is immutable. |
Поле #TITLE# неизменяемое |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Поле #TITLE# должно быть типа #TYPE# |
|
|
Settings must include "type", "name" and "code" fields. |
В настройках должны быть указаны поля |
|
|
Parameter "name" must be less than 512 characters. |
Значение параметра |
|
|
Parameter "code" must be less than 512 characters. |
Значение параметра |
|
|
Parameter "type" is not correct. |
Недопустимое значение параметра |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить коннектор biconnector.connector.update
- Получить коннектор по id biconnector.connector.get
- Получить список коннекторов biconnector.connector.list
- Удалить коннектор biconnector.connector.delete
- Получить поля коннектора biconnector.connector.fields