Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Запрос служит для получения состояния Сервиса. Запрос возвратит код ответа 200 если после запуска приложения пользователь осуществил вход с использованием личных ключей или выбрал режим работы "Без ключейЗапит служить для отримання стану Сервісу. Запит повертає код відповіді 200, якщо після запуску застосування користувач здійснює вхід із застосування особистого ключа чи обрав режим роботи "Без ключів".

URL-

...

адреса запиту

https://localhost:9094local.cipher.kiev.ua:9090/api/v1/status

Метод

GET

...

Параметри запиту

ОтсутствуетВідсутні

...

Налаштовувані заголовки

...

запиту

ОтсутствуетВідсутні

...

Відповідь
Код
ответа
відповідіContent-type
Допустимые параметрыПример содержимого
Допустимі параметриПриклад вмісту
200application/jsonmessage
{
   
    "message"
:
"
Сервисы
Сервіси 
находится
знаходиться в 
работоспособном состоянии."
працездатному стані.",
   "сryptoLibVersion":"2.0.1.2097",
   "productVersion":"4.0.4 Build #171"
}
503application/jsonmessage
{
   
    "message" : "
Сервис
Сервіс 
хранения
зберігання 
данных
даних не 
запущен
запущено." 
}

...

Параметри JSON

...

обʼєкта відповіді
Параметр
Тип
данных
даних
Описание
Опис
messageString
Описание результата проведения операции
Пример кода на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url: "https://localhost:9094/api/v1/status",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при получении состояния сервиса." : xhr.responseText;
    }
})
Опис результату проведення операції.
сryptoLibVersionStringВерсія криптобібліотеки X509.

productVersion

StringВерсія застосування (Агент ЄСКО).

...