Устанавливает некоторые параметры работы Сервиса.
Доступны следующие параметры:
- время бездействия сервиса, после которого следует запросить у пользователя пароль для доступа к ключу
URL-адрес запроса
https://local.cipher.kiev.ua:9091/api/v1/option
Метод
PUT
Параметры запроса
Отсутствуют
Настраиваемые заголовки запроса
Content-Type | application/json |
Параметры JSON объекта запроса
Имя | Тип | Описание | Допустимые значения |
---|---|---|---|
signatureType | Number | Время в секундах бездействия сервиса, после которого следует запросить у пользователя пароль для доступа к ключу | 300-3600, 901* |
* - значение по умолчанию
Ответ
Код ответа | Content-type | Допустимые параметры | Пример содержимого |
---|---|---|---|
200 | application/json | message | { |
503 | application/json | message | { |
400 | application/json | message | { "message" : "Сессия отсутствует." } |
Параметры JSON объекта ответа
Параметр | Тип данных | Описание |
---|---|---|
message | String | Описание результата проведения операции |
settedOptions | Object | Параметры и их значения, которые были установлены после выполнения запроса |
Пример кода на JavaScript + jQuery 2.2.4
var appOptions = { signatureType: 900 }; $.ajax({ url: "https://local.cipher.kiev.ua:9091/api/v1/option", type: "PUT", dataType: "json", contentType: "application/json", data: JSON.stringify(appOptions) }).done(function (jsonResponse, textStatus, xhr) { message = jsonResponse.message; settedOptions = jsonResponse.settedOptions; }).fail(function (xhr) { try { var jsonResponse = JSON.parse(xhr.responseText); message = jsonResponse.message; } catch (e) { message = (xhr.responseText == undefined) ? "Ошибка при установке параметров сервиса." : xhr.responseText; } })