Список методов Сервиса Подписи
Базовый адрес REST Сервиса Подписи:
https://<hostname>/<AppName>/rest/api
где
<hostname> - DNS-имя сервера DSS
<AppName> - имя Веб-приложения Сервиса подписи. По умолчанию - SignServer
Примечание
Аутентификация на Сервисе Подписи только по OAuth-токену, выпущенному на Центре Идентификации.
Примечание
В примерах ниже будут использованы следующие значения
<hostname> - dss.cryptopro.ru
<AppName> - SignServer
Полное описание всех методов конечных точек по категориям:
- Policy
- Requests (v1 API)
- Requests (v2 API)
- Certificates(v1 API)
- Certificates (v2 API)
- Documents (v1 API)
- Transaction (v1 API)
- Signature (v2 API)
- Decrypt (v2 API)
- Encrypt (v2 API)
- Keys
Примечание
Конечные точки Signature, Encrypt и Decrypt входят в состав v2 API. Для взаимодействия с DSS через v2 API требуется развернуть дополнительные компоненты:
- Сервис Обработки Документов
- Сервис Операций Другие конечные точки доступны как в v2 API, так и в v1 API.
Краткое описание методов конечных точек v1 API и v2 API приводится ниже.
Разное:
| Метод | Описание |
|---|---|
| /policy | Получение настроек Сервиса Подписи (Политики Сервиса Подписи) |
| /transactions (v1 API) | Создание операций с подтверждением (v1 API) (выполнение операций на Сервисе Подписи с подтверждением вторым фактором аутентификации) |
Запросы на сертификаты:
Методы работы с запросами на сертификаты 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/{cert_id}/status | Аннулирование |
| /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/{cert_id}/status | Приостановление |
| v2/certificates/{cert_id}/status | Возобновление |
| v2/certificates | Установка сертификата |
Подпись и шифрование:
Метода обработки документов v1 API:
| Тип | Описание |
|---|---|
| /documents | Отправка документа на подпись, зашифрование, расшифрование |
| /documents/packagesignature | Отправка пакета документов на подпись |
| /documents/encrypt | Зашифрование документа |
| /documents/decrypt | Расшифрование документа |
| /documents/decrypt/parse | Разбор зашифрованного документа |
| /documents/enhancesignature | Усовершенствование подписи |
Метода обработки документов v2 API:
| Тип | Описание |
|---|---|
| /v2/signature | Отправка документа или пакета документов на подпись |
| /v2/parse | Разбор зашифрованного документа Поиск подходящих сертификатов для расшифрования |
| /v2/decryption | Расшифрование документа или пакета документов |
| /v2/encryption | Зашифрование документа или пакета документов |
| /v2/enhance | Усовершенствование подписи |