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

Scope: biconnector

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

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

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

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

Название
тип

Описание

id*
integer

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

Примеры кода

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

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{
                 "id": 4
                 }' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.get
        
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
        
try
        {
        	const response = await $b24.callMethod(
        		'biconnector.connector.get',
        		{
        			id: 4,
        		}
        	);
        	
        	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.connector.get',
                    [
                        'id' => 4,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Info: ' . print_r($result->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) => {
                result.error() ? console.error(result.error()) : console.info(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.connector.get',
            [
                'id' => 4
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "item": {
                    "id": 5,
                    "title": "SUPER REST CONNECTOR",
                    "dateCreate": "2025-03-24 07:25:59",
                    "logo": "https://masterpiecer-images.s3.yandex.net/5fd531dca6427c7:upscaled",
                    "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"
                }
            },
            "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
item

Корневой элемент ответа. Содержит информацию о полях коннектора. Описание полей в статье Коннектор: обзор методов

time
time

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

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

HTTP-статус: 200

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

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-статус: 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

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

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

Предыдущая
Обновить коннектор
Следующая
Получить список коннекторов