Перейти к основному содержимому
Версия: 5.0

Настройки подключений для команды api

Для команды api существует возможность использовать предварительно созданные настройки подключения, название которых передается в команду параметром connection. Для создания или редактирования connection, перейдите в раздел Навигационное меню - Параметры системы - Настройки модулей - Список конфигураций:

Чтобы создать новое соединение, нажмите на кнопку Создать в правом верхнем углу. Для редактирования соединения нажмите на него в списке. Ниже представлен пример заполненной конфигурации для подключения :

В таблице ниже представлены основные параметры подключения:

НазваниеОписаниеПример
Имя конфигурацииИмя конфигурации, которое используется как параметр connection в команде api.test-connection, example
URL сервераURL-адрес сервера, на который будет осуществляться запрос.http://example.com
URL прокси сервераURL-адрес http-прокси сервера.72.10.160.156:8080, http://72.10.160.156:8080
Выберите тип авторизацииТип авторизации. Для Basic необходимо указать логин и пароль, для ApiKey и Bearer необходимо указать ключ. Пароль и ключ хранятся в keystore.Basic, ApiKey, Bearer
Валидация ssl SSL-валидация с использованием сертификатов.Basic, ApiKey, Bearer
Включить проверку имени хостаПроверка валидации имени хоста, указанного в сертификате.Basic, ApiKey, Bearer
Выберите вариант SSL Выбор конкретного криптографического протокола. По умолчанию TLS1.3.SSL3, TLS, TLS1.3
Путь для trust_storeПуть до самоподписанного сертификата. Если путь до сертификата указан, то необходимо указать Пароль от сертификата, который будет храниться в keystore./path/to/your/sertificate.jks

Перед сохранением конфигурации существует возможность Проверить соединение.