Проверка подключения

Запрос

Тип	Метод
POST	/integrations/test_connection

Описание: При выполнении запроса будет запущена проверка подключения экземпляра интеграции к API серверу сторонней системы.

Пример запроса

POST

Development server
https://development.gigantic-server.com/v1/integrations/test_connection

Staging server
https://staging.gigantic-server.com/v1/integrations/test_connection

Тело запроса:

Параметр	Тип	Обязательность	Описание
integration_type_id	string	Required	Идентификатор типа интеграции
integration_name	string	Required	Наименование экземпляра интеграции
state	boolean	Required	Состояние экземпляра интеграции. Возможные значения: - true - тип интеграции активирован в платформе; - false - тип интеграции неактивен.
params	Array<Params>	Required	Параметры интеграции

Params

Параметр	Тип	Обязательность	Описание
host	string	Required	Адрес API сервера
port	integer	Required	Порт
login	string	Required	Логин для подключения к серверу
password	string	Required	Пароль
is_jobs_active	boolean	Required	Использовать ли периодические задачи синхронизации: true, false
is_actions_active	boolean	Required	Использовать ли активные действия: true, false

Пример тела запроса

{
  "integration_type_id": "28581c11-33bb-4494-a053-3fc7348a93df",
  "integration_name": "Ростех-EDR Роснефть-Нижневартовск",
  "state": true,
  "params": {
    "host": "string",
    "port": 0,
    "login": "string",
    "password": "string",
    "is_jobs_active": true,
    "is_actions_active": true
  }
}

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: Ответ интегрируемой системы на запрос проверки подключения в формате string.

Другие возможные ответы

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, либо отсутствует обязательный параметр
500	Internal Server Error	Другие ошибки при удалении объектов

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

   
Код 400
   

{
  "error": "Bad Request",
  "error_code": 400
}



   
Код 500
   

{
  "error": "Internal Server Error",
  "error_code": 500
}