Список методов Сервиса Подписи

Базовый адрес REST Сервиса Подписи:

https://<hostname>/<AppName>/api

где

<hostname> - DNS-имя сервера <AppName> - имя Веб-приложения Сервиса Подписи. По умолчанию - SignServer.

Внимание!

Для обратной совместимости может быть необходимо настроить доступ к конечным точкам Сервиса Подписи с использованием базового адреса /rest/api. Для этого в конфигурационный файл nginx для Сервиса Подписи, расположенный в "/etc/opt/cprokey/signsrv/SignServer/nginx.conf" необходимо добавить секцию location следующего содержания:

location /signserver {
   rewrite /signserver/rest/(.*) /$1 break;
   proxy_pass http://localhost:51000;
}

После выполнения данной настройки необходимо перезапустить cpnginx при помощи следующей команды:

sudo systemctl restart cpnginx.service

Примечание

Аутентификация на Сервисе Подписи производится исключительно по OAuth-токену, выпущенному на Центре Идентификации.

Полное описание всех методов конечных точек по категориям:

Примечание

Конечные точки Signature, Encrypt (в составе Decrypt) и Decrypt входят в состав v2 API. Для взаимодействия с сервером через v2 API требуется развернуть дополнительные компоненты:

Сервис Обработки Документов
Сервис Операций (БД) Другие конечные точки доступны как в v2 API, так и в v1 API.

Краткое описание методов конечных точек v1 API и v2 API приведено ниже.

Разное:

Метод	Описание
/policy	Получение настроек Сервиса Подписи (Политики Сервиса Подписи)
/policy/ex	Получение расширенных настроек Сервиса Подписи (Расширенной политики Сервиса Подписи)

Запросы на сертификаты:

Методы работы с запросами на сертификаты v1 API:

Тип	Описание
/requests	Создание запроса на сертификат
/requests	Получение списка запросов на сертификаты
/requests/{key}	Получение запроса на сертификат по идентификатору
/requests/{key}	Удаление запроса на сертификат
/requests/{key}/content	Получение содержимого запроса на сертификат
/requests/revokerequests/{key}/content	Получение содержимого запроса на отзыв сертификата
/requests/{key}/status	Одобрение и отклонение запроса на сертификат
/requests/revokerequests/{key}/status	Одобрение и отклонение запроса на отзыв сертификата

Методы работы с запросами на сертификаты v2 API:

Тип	Описание
v2/requests	Создание запроса на сертификат
v2/requests	Получение списка запросов на сертификаты
v2/requests/{key}	Получение запроса на сертификат по идентификатору
v2/requests/{key}	Удаление запроса на сертификат
v2/requests/{key}/content	Получение содержимого запроса на сертификат
v2/requests/revokerequests/{key}/content	Получение содержимого запроса на отзыв сертификата
v2/requests/{key}/status	Одобрение и отклонение запроса на сертификат
v2/requests/revokerequests/{key}/status	Одобрение и отклонение запроса на отзыв сертификата

Сертификаты:

Методы работы с сертификатами с v1 API:

Тип	Описание
/certificates	Получение списка сертификатов
/certificates/{cert_id}	Получение сертификата по идентификатору
/certificates/{cert_id}	Удаление сертификата по идентификатору
/certificates/{cert_id}/content	Получение содержимого сертификата
/certificates/{cert_id}/revokerequests	Получение списка запросов на отзыв сертификата
/certificates/{cert_id}/pin	Смена ПИН-кода
/certificates/{cert_id}/default	Назначение сертификата по умолчанию
/certificates/{cert_id}/friendlyname	Назначение дружественного имени
/certificates/{cert_id}/status	Отзыв сертификата
/certificates	Установка сертификата

Методы работы с сертификатами с v2 API:

Тип	Описание
v2/certificates	Получение списка сертификатов
v2/certificates/{cert_id}	Получение сертификата по идентификатору
v2/certificates/{cert_id}	Удаление сертификата по идентификатору
v2/certificates/{cert_id}/content	Получение содержимого сертификата
v2/certificates/{cert_id}/revokerequests	Получение списка запросов на отзыв сертификата
v2/certificates/{cert_id}/pin	Смена ПИН-кода
v2/certificates/{cert_id}/default	Назначение сертификата по умолчанию
v2/certificates/{cert_id}/friendlyname	Назначение дружественного имени
v2/certificates/{cert_id}/status	Отзыв сертификата
v2/certificates	Установка сертификата

Подпись, хэширование и шифрование:

Методы обработки документов v1 API:

Тип	Описание
/documents	Отправка документа на подпись, зашифрование, расшифрование
/documents/encrypt	Зашифрование документа
/documents/decrypt/parse	Разбор зашифрованного документа
/documents/enhancesignature	Усовершенствование подписи
/documents/hash	Хэширование документа

Методы обработки документов v2 API:

Тип	Описание
/v2/signature	Отправка документа или пакета документов на подпись
/v2/parse	Разбор зашифрованного документа Поиск подходящих сертификатов для расшифрования
/v2/decryption	Расшифрование документа или пакета документов
/v2/encryption	Зашифрование документа или пакета документов
/v2/enhance	Усовершенствование подписи
/v2/hash	Хэширование документа