REST API Сервиса Подписи
Данный раздел содержит руководство разработчика по интеграции с Сервисом Подписи. В разделе приведено подробное описание методов и типов данных REST-интерфейса Сервиса Подписи, сценариев взаимодействия с Сервисом Подписи с примерами HTTP запросов и ответов.
Сценарии:
- Создание запроса на сертификат (v1 API)
- Создание запроса на сертификат в мобильном приложении (v2 API)
- Асинхронная подпись (v2 API)
- Подпись документов ФТС
Конечные точки:
Типы данных:
- Результат обработки документов (BinaryOperationResult)
- Результат обработки документа (BinaryResult)
- Параметры УЦ (DssCaPolicy)
- Представление сертификата и запроса на сертификат (DSSCertificateFormatEnum)
- Параметры запроса на сертификат (CertificateRequest)
- Типы статусов сертификата (DSSCertificateStatusEnum)
- Статус сертификата v1 (CertificateStatus)
- Статус сертификата v2 (CertificateStatus)
- Сертификат (DSSCertificateEx)
- Тип сертификата (CertificateType)
- Данные для создания запроса на сертификат (CreateCertificateRequestOperationInput)
- Параметры криптопровайдеров
- Параметры расшифрования
- Запрос операции расшифрования
- Результат расшифрования (DSSDecryptDocumentResponse)
- Данные для назначения сертификата по умолчанию (DefaultProperty)
- Информация о документе (BinaryDataDescription)
- Данные о пакете документов (DSSSignDocumentResponse)
- Данные о пакете документов (DocumentPackage)
- Тип обработки пакета документов (PackageOperationConfirmationMode)
- Данные о документе (Document)
- Политика Сервиса Подписи (DssPolicy)
- Расширенная политика Сервиса Подписи (DSSRestPolicyEx)
- Параметры шифрования
- Типы шифрования (EncryptionType)
- Запрос операции зашифрования
- Параметры усовершенствования подписи (EnhanceOperation)
- Данные для назначения дружественного имени (FriendlyNameProperty)
- Результат операции генерации закрытого ключа (GenKeyOutput)
- Запрос на установку сертификата из PFX (InstallCertificateFromPfxRequest)
- Тип размещения ключа (KeyStorageType)
- Сведения о хранении ключа пользователя (KeyStorageInfo)
- Типы транзакций
- Статус документа в операции (OperationActionStatus)
- Статус операции (OperationStatus)
- Данные об операции (OperationInfo)
- Данные о результате выполнения операции (OperationResultInfo)
- Информация о подходящих сертификатах расшифрования (ParsedDocumentInfo)
- Результат операции определения подходящих сертификатов расшифрования (ParseInfo)
- Запрос операции определения сертификатов расшифрования
- Данные для смены ПИН-кода v1 (RequestChangePin)
- Данные для смены ПИН-кода v2 (RequestChangePin)
- Параметры запроса на сертификат
- Статус запроса на сертификат (DSSRequestStatusEnum)
- Статус сертификата (RequestStatus)
- Запрос на сертификат (DSSCertRequest)
- Тип запроса (CARequestTypeEnum)
- Информация об отзыве сертификата (RevocationInfo)
- Причины отзыва сертификата (CertRevokeReasonEnum)
- Сведения об отзыве (DSSRevRequest)
- Сведения об операции подписи (SignatureOperation)
- Дополнительные параметры подписи
- Компонент различительного имени (SubjectNameComponent)
- Параметры транзакций
- Запрос на валидацию ПИН-кода (ValidatePinRequest)
- Результат валидации ПИН-кода (ValidatePinResult)