Создать источник biconnector.source.add

Scope: biconnector

Кто может выполнять метод: пользователь с доступом к разделу «Рабочее место аналитика»

Метод biconnector.source.add создает новый источник данных, связанный с коннектором.

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

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

Название
тип

Описание

fields*
object

Объект, содержащий данные для создания нового источника. Формат объекта:

{
            "field_1": "value_1",
            "field_2": "value_2",
            ...,
            "field_n": "value_n"
        }

field_n — название поля
value_n — значение поля

Подробное описание ниже

Параметр fields

Название `тип`	Описание
title* `string`	Название источника
description `string`	Описание источника
active `boolean`	Активность источника. По умолчанию `true`
connectorId* `integer`	Идентификатор коннектора, можно получить методами biconnector.connector.list или biconnector.connector.add
settings* `object`	Список параметров для авторизации, передается объектом, где ключ — `code` параметра. Параметры можно получить методами biconnector.connector.list или biconnector.connector.get

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"CRM Source","description":"Источник данных CRM","connectorId":123,"settings":{"login":"admin","password":"qwerty"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"title":"CRM Source","description":"Источник данных CRM","connectorId":123,"settings":{"login":"admin","password":"qwerty"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/biconnector.source.add

try
        {
        	const response = await $b24.callMethod(
        		'biconnector.source.add',
        		{
        			fields: {
        				"title": "CRM Source",
        				"description": "Источник данных CRM",
        				"connectorId": 123,
        				"settings": {
        					"login": "admin",
        					"password": "qwerty"
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error() ? console.error(result.error()) : console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.source.add',
                    [
                        'fields' => [
                            "title"       => "CRM Source",
                            "description" => "Источник данных CRM",
                            "connectorId" => 123,
                            "settings"    => [
                                "login"    => "admin",
                                "password" => "qwerty"
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($response->getError()) {
                error_log($response->getError());
                echo 'Error: ' . $response->getError();
            } else {
                echo 'Success: ' . print_r($result, true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding source: ' . $e->getMessage();
        }

BX24.callMethod(
            'biconnector.source.add',
            {
                fields: {
                    "title": "CRM Source",
                    "description": "Источник данных CRM",
                    "connectorId": 123,
                    "settings": {
                        "login": "admin",
                        "password": "qwerty"
                    }
                }
            },
            (result) => {
                result.error() ? console.error(result.error()) : console.info(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.source.add',
            [
                'fields' => [
                    'title' => 'CRM Source',
                    'description' => 'Источник данных CRM',
                    'connectorId' => 123,
                    'settings' => [
                        'login' => 'admin',
                        'password' => 'qwerty'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
              "id": 7
            },
            "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 `integer`	Корневой элемент ответа, содержит идентификатор созданного источника
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 200

{
            "error": "VALIDATION_FIELDS_NOT_PROVIDED",
            "error_description": "Fields not provided."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Значение
`VALIDATION_FIELDS_NOT_PROVIDED`	Fields not provided.	Поля не переданы в запросе
`VALIDATION_UNKNOWN_PARAMETERS`	Unknown parameters: #LIST_OF_PARAMS#	Обнаружены неизвестные параметры: перечень
`VALIDATION_REQUIRED_FIELD_MISSING`	Field "#TITLE#" is required.	Обязательное поле #TITLE# не передано
`VALIDATION_READ_ONLY_FIELD`	Field "#TITLE#" is read only.	Поле #TITLE# доступно только для чтения и не может быть изменено
`VALIDATION_IMMUTABLE_FIELD`	Field "#TITLE#" is immutable.	Поле #TITLE# неизменяемое
`VALIDATION_INVALID_FIELD_TYPE`	Field "#TITLE#" must be of type #TYPE#.	Поле #TITLE# должно быть типа #TYPE#
`CONNECTOR_NOT_FOUND`	Connector was not found.	Коннектор не найден
`SOURCE_CREATE_CONNECTION_ERROR`	Cannot create connection.	Ошибка при создании подключения
`SOURCE_UPDATE_CONNECTION_ERROR`	Cannot update connection.	Ошибка при обновлении подключения
`BX_ERROR`	Cannot delete source. Delete all related datasets first.	Нельзя удалить источник, пока существуют связанные датасеты

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Обновить источник

Создать источник biconnector.source.add

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

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

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

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

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