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

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

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

Scope: biconnector

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

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

Метод работает только в контексте приложения и только с теми коннекторами, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED

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

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

Название
тип

Описание

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

Активность источника.
Метод игнорирует переданное значение: созданный источник всегда активен

connectorId*
integer

Идентификатор коннектора, можно получить методами biconnector.connector.list или biconnector.connector.add

settings*
object

Значения параметров авторизации (подробное описание)

При создании источника Битрикс24 обращается к эндпоинту проверки подключения коннектора. Если внешняя система не ответит, метод вернет ошибку SOURCE_CREATE_CONNECTION_ERROR и источник не создастся.

Параметр settings

Передавайте settings объектом, где ключ — это code параметра, объявленного коннектором, а значение — то, что нужно подставить при подключении. Коды параметров можно получить методами biconnector.connector.list или biconnector.connector.get. Ключи, которых нет в описании коннектора, отбрасываются без ошибки.

Если коннектор объявил параметры с кодами login и password, поле выглядит так:

{
    "settings": {
        "login": "admin",
        "password": "qwerty"
    }
}

В ответе методов biconnector.source.get и biconnector.source.list то же поле приходит массивом объектов с полями id, code, name, type и value. Обе формы разобраны в разделе Поле settings.

Метод biconnector.source.fields объявляет settings типом array, но на вход метод biconnector.source.add принимает его объектом.

Значения параметров авторизации методы biconnector.source.get и biconnector.source.list возвращают в открытом виде, включая пароли и токены

Примеры кода

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

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
// 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

// Methods of this section put errors inside result and answer with HTTP 200
type BiconnectorError = {
  error: {
    error: string
    error_description: string
  }
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type SourceAddResult = {
  id: number
}

try {
  const response = await $b24.actions.v2.call.make<SourceAddResult | BiconnectorError>({
    method: 'biconnector.source.add',
    params: {
      fields: {
        title: 'CRM Source',
        description: 'Источник данных CRM',
        connectorId: 123,
        settings: {
          login: 'admin',
          password: 'qwerty',
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result

    // The SDK sees HTTP 200 as success, so check the error inside result yourself
    if ('error' in result) {
      console.error(result.error.error, result.error.error_description)
    } else {
      console.info('Created source id:', result.id)
    }
  }
} 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 addSource() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'biconnector.source.add',
        params: {
          fields: {
            title: 'CRM Source',
            description: 'Источник данных CRM',
            connectorId: 123,
            settings: {
              login: 'admin',
              password: 'qwerty',
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result

      // The SDK sees HTTP 200 as success, so check the error inside result yourself
      if (result && result.error) {
        console.error(result.error.error, result.error.error_description)
        return
      }

      console.info('Created source id:', result.id)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.biconnector.source.add(
        fields={
            "title": "CRM Source",
            "description": "Источник данных CRM",
            "connectorId": 123,
            "settings": {
                "login": "admin",
                "password": "qwerty",
            },
        },
    ).response
    result = bitrix_response.result

    # Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
    if isinstance(result, dict) and "error" in result:
        print(
            "Ошибка BIconnector",
            f"error: {result['error']['error']}",
            f"error_description: {result['error']['error_description']}",
            sep="\n",
        )
    else:
        print(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(
            'biconnector.source.add',
            [
                'fields' => [
                    "title"       => "CRM Source",
                    "description" => "Источник данных CRM",
                    "connectorId" => 123,
                    "settings"    => [
                        "login"    => "admin",
                        "password" => "qwerty"
                    ]
                ]
            ]
        );

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

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        $data = $result->data();

        // Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
        if (isset($data['error'])) {
            echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
        } else {
            echo 'Success: ' . print_r($data, 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) => {
        if (result.error()) {
            console.error(result.error());
            return;
        }

        const data = result.data();

        // Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
        if (data && data.error) {
            console.error(data.error.error, data.error.error_description);
            return;
        }

        console.info(data);
    }
);
require_once('crest.php');

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

// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200
if (isset($result['result']['error'])) {
    echo 'BIconnector error: ' . $result['result']['error']['error']
        . ': ' . $result['result']['error']['error_description'];
} else {
    echo '<PRE>';
    print_r($result);
    echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "biconnector.source.add", b24.Params{
	"fields": b24.Params{
		"title":       "CRM Source",
		"description": "Источник данных CRM",
		"connectorId": 123,
		"settings": b24.Params{
			"login":    "admin",
			"password": "qwerty",
		},
	},
})
if err != nil {
	return fmt.Errorf("biconnector.source.add: %w", err)
}

// Методы раздела кладут ошибку внутрь result и отвечают со статусом 200.
var apiErr struct {
	Error *struct {
		Error       string `json:"error"`
		Description string `json:"error_description"`
	} `json:"error"`
}
if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
	return fmt.Errorf("biconnector.source.add: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}

var item struct {
	ID b24.ID `json:"id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID)

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

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
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

id
integer

Идентификатор созданного источника. Используйте его в методах biconnector.source.get, biconnector.source.update и biconnector.source.delete

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

HTTP-статус: 200

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

Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ACCESS_DENIED

Access denied.

Нет одного из двух прав, либо метод вызван вебхуком или вне контекста приложения

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_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.

Внешняя система не ответила на запрос к эндпоинту проверки подключения — источник не создан

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

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

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

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