Обновить источник biconnector.source.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
biconnectorКто может выполнять метод: пользователь с правами «Доступ к BI Конструктору» и «Доступ к рабочему месту аналитика» одновременно
Метод biconnector.source.update обновляет существующий источник.
Метод работает только в контексте приложения и изменяет только те источники, которые приложение создало само. При вызове вебхуком метод возвращает ошибку ACCESS_DENIED
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор источника, можно получить методами biconnector.source.list и biconnector.source.add |
|
fields* |
Объект, содержащий обновляемые данные.
|
Параметр fields
|
Название |
Описание |
|
title* |
Новое название источника |
|
description |
Новое описание источника |
|
active |
Активность источника. |
|
settings |
Значения параметров авторизации (подробное описание) |
Метод изменяет только переданные поля: то, что вы не передали, сохраняется у источника без изменений. Это верно и для settings — настройки сливаются по ключу, поэтому передавайте только те параметры авторизации, которые нужно изменить.
Поле connectorId задается один раз при создании источника, изменить его методом biconnector.source.update нельзя.
При каждом обновлении Битрикс24 обращается к эндпоинту проверки подключения коннектора, даже если settings в запросе не было. Если внешняя система не ответит, метод вернет ошибку SOURCE_UPDATE_CONNECTION_ERROR.
Параметр settings
Передавайте settings объектом, где ключ — это code параметра, объявленного коннектором, а значение — то, что нужно подставить при подключении. Коды параметров можно получить методами biconnector.connector.list или biconnector.connector.get. Ключи, которых нет в описании коннектора, отбрасываются без ошибки.
Если коннектор объявил параметры с кодами login и password, поле выглядит так:
{
"settings": {
"login": "new_admin",
"password": "new_password"
}
}
В ответе методов biconnector.source.get и biconnector.source.list то же поле приходит массивом объектов с полями id, code, name, type и value. Обе формы разобраны в разделе Поле settings.
Метод biconnector.source.fields объявляет settings типом array, но на вход метод biconnector.source.update принимает его объектом.
Значения параметров авторизации методы biconnector.source.get и biconnector.source.list возвращают в открытом виде, включая пароли и токены
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"id": 4,
"fields": {
"title": "Новое название источника",
"description": "Обновленное описание источника",
"settings": {
"login": "new_admin",
"password": "new_password"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.update
// 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
}
}
try {
const response = await $b24.actions.v2.call.make<boolean | BiconnectorError>({
method: 'biconnector.source.update',
params: {
id: 4,
fields: {
title: 'Новое название источника',
description: 'Обновленное описание источника',
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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 (typeof result === 'object' && result !== null && 'error' in result) {
console.error(result.error.error, result.error.error_description)
} else {
console.info('Source updated:', result)
}
}
} 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 updateSource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.update',
params: {
id: 4,
fields: {
title: 'Новое название источника',
description: 'Обновленное описание источника',
settings: {
login: 'new_admin',
password: 'new_password',
},
},
},
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('Source updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateSource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.update(
bitrix_id=4,
fields={
"title": "Новое название источника",
"description": "Обновленное описание источника",
"settings": {
"login": "new_admin",
"password": "new_password",
},
},
).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.update',
[
'id' => 4,
'fields' => [
"title" => "Новое название источника",
"description" => "Обновленное описание источника",
"settings" => [
"login" => "new_admin",
"password" => "new_password"
]
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($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 updating source: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.source.update',
{
id: 4,
fields: {
"title": "Новое название источника",
"description": "Обновленное описание источника",
"settings": {
"login": "new_admin",
"password": "new_password"
}
}
},
(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.update',
[
'id' => 4,
'fields' => [
'title' => 'Новое название источника',
'description' => 'Обновленное описание источника',
'settings' => [
'login' => 'new_admin',
'password' => 'new_password'
]
]
]
);
// Методы раздела кладут ошибку внутрь 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.update", b24.Params{
"id": 4,
"fields": b24.Params{
"title": "Новое название источника",
"description": "Обновленное описание источника",
"settings": b24.Params{
"login": "new_admin",
"password": "new_password",
},
},
})
if err != nil {
return fmt.Errorf("biconnector.source.update: %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.update: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1725365418.056843,
"finish": 1725365419.671506,
"duration": 1.6146628856658936,
"processing": 1.3475170135498047,
"date_start": "2024-09-03T14:10:18+02:00",
"date_finish": "2024-09-03T14:10:19+02:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Результат обновления. При успешном обновлении приходит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 200
{
"result": {
"error": {
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
}
}
Метод возвращает ошибку внутри поля result и с HTTP-статусом 200. Проверяйте result.error: обертки SDK разбирают только верхний уровень ответа и такую ошибку считают успехом
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied. |
Нет одного из двух прав, либо метод вызван вебхуком или вне контекста приложения |
|
|
ID is missing. |
Идентификатор не указан |
|
|
ID has to be a positive integer. |
Неверный формат ID |
|
|
Fields not provided. |
Поля не переданы в запросе |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Обнаружены неизвестные параметры: перечень |
|
|
Field "#TITLE#" is read only. |
Поле #TITLE# доступно только для чтения и не может быть изменено |
|
|
Field "#TITLE#" is immutable. |
Поле #TITLE# неизменяемое |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Поле #TITLE# должно быть типа #TYPE# |
|
|
Source was not found. |
Источника нет или он принадлежит другому приложению |
|
|
Cannot update connection. |
Внешняя система не ответила на запрос к эндпоинту проверки подключения — источник не обновлен |
|
Пустое значение |
All the fields are required. |
Не передан обязательный параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |