Конечная точка Signature

Конечная точка Signature предназначена для создания операций подписи документов.

Методы данной конечной точки позволяют выполнять операции над множеством документов, содержимое которых загружается из удалённого хранилища.

Создание операции подписи

Метод предназначен для создания операции подписи документов.

Параметр	Значение
HTTP-метод	POST
Путь	/v2/signature
Параметры	Объект SignatureOperation, содержащий сведения об операции подписи.
Возвращаемое значение	Объект OperationInfo, содержащий сведения о созданной операции.

Если операция подписи требует подтверждения, то поле Status будет содержать значение Created, иначе Completed.

Пример запроса

POST /SignServer/rest/api/v2/signature HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ...

{
    "BinaryData": [{"RefId": "3a6629fa-5759-4d4a-8602-0df7ac8420aa"}],
    "Signature" : 
    { 
        "CertificateId": "0",
        "ProcessingTemplateId": "1"
    }
}

Примеры ответов

Операция требует подтверждения.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "Operation": {
        "Id": "ea2eb4e5-dc7c-4c33-9b72-5efba3fd0f75",,
        "Status": "Created"
    }
}

Операция не требует подтверждения, результат подписи возвращён в ответе.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "Operation": {
        "Id": "ea2eb4e5-dc7c-4c33-9b72-5efba3fd0f75",
        "Result": {
            "ProcessedDocuments": [
                {
                    "RefId": "257c1cbb-6494-45ee-9a00-d55a63e5b703",
                    "OriginalRefId": "3a6629fa-5759-4d4a-8602-0df7ac8420aa",
                    "Status": "Completed"
                }
            ]
        },
        "Status": "Completed"
    }
}

Выполнение операции подписи

Метод предназначен для выполнения операции подписи документов после подтверждения.

Параметр	Значение
HTTP-метод	POST
Путь	/v2/signature
Параметры	Объект SignatureOperation, содержащий сведения об операции подписи.
Возвращаемое значение	Объект OperationInfo, содержащий сведения о созданной операции.

Для выполнения подтверждённой операции запрос отправляется на ту же конечную точку, что и при создании операции.

В теле запроса в структуре SignatureOperation может быть заполнено только одно поле PinCode, если ПИН-код для доступа к ключу не требуется, то весь запрос представляет из себя пустой JSON-объект.

Примеры запросов

Без передачи ПИН-кода для доступа к закрытому ключу сертификата.

POST /SignServer/rest/api/v2/signature HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ...

{}

C передачей ПИН-кода для доступа к закрытому ключу сертификата.

POST /SignServer/rest/api/v2/signature HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ...

{
    "Signature" : 
    { 
        "PinCode" : "1234567890"
    }
}

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "Operation": {
        "Id": "ea2eb4e5-dc7c-4c33-9b72-5efba3fd0f75",
        "Result": {
            "ProcessedDocuments": [
                {
                    "RefId": "257c1cbb-6494-45ee-9a00-d55a63e5b703",
                    "OriginalRefId": "3a6629fa-5759-4d4a-8602-0df7ac8420aa",
                    "Status": "Completed"
                }
            ]
        },
        "Status": "Completed"
    }
}