Получить коннектор по id biconnector.connector.get

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

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

Scope: biconnector

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

Метод biconnector.connector.get возвращает информацию о коннекторе по идентификатору.

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

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

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

Название
тип

Описание

id*
integer

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

Примеры кода

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

curl -X POST \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
         "id": 4,
         "auth": "**put_access_token_here**"
         }' \
     https://**put_your_bitrix24_address**/rest/biconnector.connector.get
// 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 ConnectorGetResult = {
  item: {
    id: number
    title: string
    dateCreate: string // Y-m-d H:i:s, not ISO 8601
    logo: string
    description: string
    sort: number
    urlCheck: string
    settings: Array<{
      name: string
      code: string
      type: string
    }>
    urlData: string
    urlTableList: string
    urlTableDescription: string
    supportMapping: boolean
    sourceCode: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<ConnectorGetResult | BiconnectorError>({
    method: 'biconnector.connector.get',
    params: {
      id: 4,
    },
    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(result.item.id, result.item.title, result.item.settings)
    }
  }
} 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 getConnector() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'biconnector.connector.get',
        params: {
          id: 4,
        },
        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(result.item.id, result.item.title, result.item.settings)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.biconnector.connector.get(
        bitrix_id=4,
    ).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.connector.get',
            [
                'id' => 4,
            ]
        );

    $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 'Info: ' . print_r($data, true);
        }
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error calling biconnector.connector.get: ' . $e->getMessage();
}
BX24.callMethod(
    'biconnector.connector.get',
    {
        id: 4,
    },
    (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.connector.get',
    [
        'id' => 4
    ]
);

// Методы раздела кладут ошибку внутрь 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.connector.get", b24.Params{
	"id": 4,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("biconnector.connector.get: %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.connector.get: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID          b24.ID `json:"id"`
	Title       string `json:"title"`
	DateCreate  string `json:"dateCreate"`
	Logo        string `json:"logo"`
	Description string `json:"description"`
	Sort        int    `json:"sort"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Title)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 4,
            "title": "SUPER REST CONNECTOR",
            "dateCreate": "2025-03-24 07:25:59",
            "logo": "https://app.domain/logo.png",
            "description": "Connector with token",
            "sort": 100,
            "urlCheck": "http://app.domain/check",
            "settings": [
                {
                    "name": "Логин",
                    "code": "login",
                    "type": "STRING"
                },
                {
                    "name": "Пароль",
                    "code": "password",
                    "type": "STRING"
                }
            ],
            "urlData": "http://app.domain/data",
            "urlTableList": "http://app.domain/table_list",
            "urlTableDescription": "http://app.domain/table_description",
            "supportMapping": false,
            "sourceCode": ""
        }
    },
    "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
object

Корневой элемент ответа. Содержит единственный ключ item

result.item
object

Данные коннектора (подробное описание)

time
time

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

Объект item

Название
тип

Описание

id
integer

Уникальный идентификатор коннектора

title
string

Название коннектора

logo
string

URL логотипа или строка base64

description
string

Описание коннектора

sort
integer

Порядок сортировки. Если при создании значение не передавали, приходит 100

urlCheck
string

Эндпоинт для проверки соединения

urlData
string

Эндпоинт для получения данных

urlTableList
string

Эндпоинт для получения списка таблиц

urlTableDescription
string

Эндпоинт для получения описания таблицы

settings
array

Массив параметров подключения. Каждый элемент содержит поля code и name типа string и поле type со значением STRING или INT, (подробное описание). Значения параметров хранит источник, коннектор возвращает только их коды и названия

supportMapping
boolean

Поддержка сопоставления полей таблицы с полями внешней системы

sourceCode
string

Символьный код внешней системы. Если код не задавали, поле приходит пустой строкой

dateCreate
datetime

Дата создания коннектора в формате Y-m-d H:i:s

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

HTTP-статус: 200

{
    "result": {
        "error": {
            "error": "VALIDATION_ID_NOT_PROVIDED",
            "error_description": "ID is missing."
        }
    }
}

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ACCESS_DENIED

Access denied.

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

VALIDATION_ID_NOT_PROVIDED

ID is missing.

Идентификатор не указан

VALIDATION_INVALID_ID_FORMAT

ID has to be a positive integer.

Неверный формат ID

CONNECTOR_NOT_FOUND

Connector was not found.

Коннектора нет или он принадлежит другому приложению

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

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

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

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