REST API Ключ Lite

Ключ Lite в режиме программного интерфейса (REST API) позволяет подписывать документы электронной подписью, используя при этом интегрированную с ним систему и средство ЭП, установленное на устройстве пользователя.

Ключи ЭП и закрытые ключи пользователей создаются и хранятся непосредственно на устройстве пользователя, где выполняются криптографические операции с использованием КриптоПро CSP или другого СКЗИ, имеющего действующий сертификат соответствия ФСБ России.

Данный раздел содержит руководство разработчика Ключ Lite. REST-интерфейс предоставляет конечные точки для доступа к следующим функциям сервиса:

  • Создание подписи;
  • Усовершенствование подписи;
  • Получение политики сервиса.

В рамках REST API взаимодействие с сервисом осуществляется посредством HTTP-запросов.

Общий префикс для всех конечных точек сервиса: https://{{hostname}}/{{InstanceNameName}}/rest, где {{hostname}} – адрес сервера, на котором расположен экземпляр сервиса, {{InstanceNameName}} – название веб-приложения сервиса.

Входные параметры передаются в теле самого запроса (только для HTTP методов POST и PATCH). Все объекты передаются и возвращаются в формате JSON, списки возвращаются в виде массивов JSON объектов. Массивы байтов передаются в виде строк в кодировке BASE64.

Конечные точки

Типы данных