Проверка соединения (v1/connection/check)
Назначение
Используется для детальной проверки доступности сервиса Маркет при подключении личного кабинета в Маркет.Коннекторе.
Пример запроса
Запрос проверки соединения с базой Маркет
POST /ExternalExchange/v1/connection/check
Тело запроса
{
"externalSystemId": "29e86b162",
"infobaseConnectionHash": "34450785C396D7EFD607B4801B95BD9B",
"accounts": [
{
"merchantId": "77624623f"
},
{
"merchantId": "7785e295a"
}
]
}
JS
Успешный ответ
Тело ответа
{
"externalSystemId": "29e86b162",
"infobaseConnectionHash": "34450785C396D7EFD607B4801B95BD9B",
"message": "Сhecking the connection to the database was successful",
"success": true,
"accounts": [
{
"merchantId": "77624623f",
"success": true,
"message": "The Marketplace account is identified by the MerchantId"
},
{
"merchantId": "7785e295a",
"success": true,
"message": "The Marketplace account is identified by the MerchantId"
}
]
}
JS
Ответ с ошибкой
Тело ответа с ошибкой
{
"externalSystemId": "29e86b162",
"infobaseConnectionHash": "34450785C396D7EFD607B4801B95BD9B",
"message": "Request has errors",
"success": false,
"errors": [
{
"merchantId": "77624623f",
"success": false,
"message": "Marketplace account not found by merchantId"
},
{
"merchantId": "7785e295a",
"success": true,
"message": "The Marketplace account is identified by the MerchantId" }
]
}
JS
Описание запроса
Параметр | Тип | Обязателен | Описание | |
---|---|---|---|---|
1 | externalSystemId | Строка | Да | Код внешней системы откуда идет запрос к сервису |
2 | infobaseConnectionHash | Строка | Нет | Хеш соединения с текущей ИБ, если указан, то выполняется проверка хеша соединения ИБ |
3 | accounts | Массив | Нет | Массив идентификаторов личных кабинетов для проверки |
4 | mechantId | Строка | Нет | Код личного кабинета для проверки в системе Маркета |
Описание ответа
Параметр | Тип | Обязателен | Описание | |
---|---|---|---|---|
1 | externalSystemId | Строка | Да | Код внешней системы откуда идет запрос к сервису |
2 | infobaseConnectionHash | Строка | Нет | Хеш соединения с текущей ИБ, если указан, то выполняется проверка хеша соединения ИБ |
3 | successInAllSubrequests | Булево | Да | Признак выполнения всех позиций запроса |
4 | message | Строка | Да | Описание результата запроса |
5 | success | Булево | Да | Общий статус запроса |
6 | accounts | Массив | Нет | Массив идентификаторов личных кабинетов для проверки |
7 | mercahntId | Строка | Нет | Код личного кабинета, к которому относится сообщение об ошибке |
8 | message | Строка | Да | Описание ошибки соединения с аккаунтом |
9 | success | Булево | Да | Статус позиции запроса |