Cryptography API
Группа методов для работы с криптографией при обмене документами.
Описание методов
Данный блок содержит подробное описание по каждому методу API.
[POST]/api/v1/cryptography/requests/{requestId}/sign
Прикрепление подписи к документу.
Основной сценарий Прикрепить подпись к черновику, ответному титулу или транзакции.
Параметры в строке запроса
| Название | Обязат. | Место | Тип | Описание |
|---|---|---|---|---|
| requestId | Да | Path | string(uuid) | Идентификатор запроса криптооперации. |
Тело запроса
Тип запроса: multipart/form-data
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| DocumentSign | Да | string(binary) | Файл с подписью к документу (ВАЖНО: Подпись должна быть ОТКРЕПЛЕННОЙ). |
Возможные ответы метода
| Код | Тип | Описание |
|---|---|---|
| 200 | Без данных | Подпись успешна прикреплена. |
| 400 | Без данных | Переданы некорректные параметры запроса. |
| 401 | Без данных | Пользователь не авторизован. |
| 403 | Без данных | Отказано в доступе. |
| 404 | Без данных | Ресурс не найден. |
| 500 | Без данных | Внутренняя ошибка сервера. |
[PATCH]/api/v1/cryptography/requests/{requestId}/reject
Отмена подписания документа, либо указание ошибки при подписании.
Основной сценарий Указать ошибку при подписании.
Дополнительный сценарий Сбросить статус ДО, к которому относится запрос на подпись, при статусе "подписывается".
При использовании стоит иметь в виду, что не все запросы на подпись могут быть отменены.
Параметры в строке запроса
| Название | Обязат. | Место | Тип | Описание |
|---|---|---|---|---|
| requestId | Да | Path | string(uuid) | Идентификатор запроса криптооперации. |
Тело запроса
Тип запроса: multipart/form-data
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| message | Нет | string |
Пример модели
Возможные ответы метода
| Код | Тип | Описание |
|---|---|---|
| 200 | Без данных | Подписание отмечено как отменённое. |
| 400 | Без данных | Переданы некорректные параметры запроса. |
| 401 | Без данных | Пользователь не авторизован. |
| 403 | Без данных | Отказано в доступе. |
| 404 | Без данных | Ресурс не найден. |
| 500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/cryptography/requests/{requestId}/file
Выгрузка файла для подписания.
Основной сценарий Выгрузить файл для последующего подписания.
Параметры в строке запроса
| Название | Обязат. | Место | Тип | Описание |
|---|---|---|---|---|
| requestId | Да | Path | string(uuid) | Идентификатор запроса криптооперации. |
Возможные ответы метода
| Код | Тип | Описание |
|---|---|---|
| 200 | string(binary) | Файл черновика. |
| 400 | Без данных | Переданы некорректные параметры запроса. |
| 401 | Без данных | Пользователь не авторизован. |
| 403 | Без данных | Отказано в доступе. |
| 404 | Без данных | Ресурс не найден. |
| 500 | Без данных | Внутренняя ошибка сервера. |
[GET]/api/v1/cryptography/requests
Получение списка запросов на подпись.
Основной сценарий Получить список документов, ожидающих подписи, с последующим подписанием и продолжением ДО.
Параметры в строке запроса
| Название | Обязат. | Место | Тип | Описание |
|---|---|---|---|---|
| abonentId | Да | Header | string(uuid) | Внутренний идентификатор абонента. |
Возможные ответы метода
| Код | Тип | Описание |
|---|---|---|
| 200 | SignRequestResultList | Список документов на подпись. |
| 400 | Без данных | Переданы некорректные параметры запроса. |
| 401 | Без данных | Пользователь не авторизован. |
| 403 | Без данных | Отказано в доступе. |
| 404 | Без данных | Ресурс не найден. |
| 500 | Без данных | Внутренняя ошибка сервера. |
Пример успешного ответа
Описание дополнительных моделей
Данный блок содержит описание дополнительных моделей.
SignRequest
Запрос на подпись документа
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| id | Да | string(uuid) | Идентификатор запроса на подпись. |
| docflowId | Нет | string(uuid) | Идентификатор документооборота (не указывается для черновиков). |
| docflowPartId | Нет | string(uuid) | Идентификатор части документооборота (не указывается для черновиков). Это не тоже самое, что общий идентификатор документооборота, данный идентификатор уникален для каждой стороны в рамках одного обмена документами. |
| transactionId | Нет | string(uuid) | Идентификатор транзакции документооборота (не указывается для черновиков). |
| documentId | Да | string(uuid) | Идентификатор документа (для черновиков поле содержит идентификатор черновика "DraftId == DocumentId"). |
| signerAbonentId | Да | string(uuid) | Внутренний идентификатор абонента отправителя-подписанта. |
| certificateSkid | Да | string | Идентификатор ключа субъекта сертификата. |
| requestTime | Да | date-time-offset | Время создания заявки. |
Пример модели
SignRequestResultList
Список с результатом поиска.
| Название | Обязат. | Тип | Описание |
|---|---|---|---|
| count | Да | integer(int32) | Количество элементов в результате. |
| data | Да | SignRequest[array] | Список элементов в результате. |