POST /signatures

Метод позволяет создать операцию подписи документов сертификатом. В одной операции может содержаться несколько файлов.

Информация о созданной операции будет храниться в базе 3 месяца.

Заголовки

Название Описание
Content-Type Тип контента
Authorization Заголовок авторизации

Content-Type

Допустимые значения Content-Type:

  • Application/json

Тело запроса

Название Тип Формат Обязательность Описание
externalId string ^\w{1,256}$ false Клиентский идентификатор операции. Заполняется клиентом. Система контролирует уникальность идентификатора.
correlationId string ^\w{1,256}$ false Идентификатор, который используется для связи нескольких операций подписи.
certificateId string Guid true Идентификатор сертификата, которым необходимо подписать контенты.
contents array Content true Список контентов, которые необходимо подписать. Заполняются без описания подписей.

Все контенты необходимо предварительно загрузить методом POST /contents

Допустимые форматы документов:

  • pdf;
  • png;
  • jpg;
  • jpeg;
  • tiff
  • xml.

Пример

POST /realty/crypto/v2/signatures
Content-Type: Application/json
Authorization: ReestroAuth apiKey=235dc85c-f7f9-4dc0-8bbf-dad9e0185afd&portal.orgid=1748b89b-7d34-4d47-b479-b06b40ab1a30
{
  "certificateId": "70f78249-dc69-450f-ab38-19974a310020",
  "contents:":
  [
    {
      "contentInfo":
      {
         "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
         "contentType":"pdf",
         "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
      }
    }
  ]
}

Ответы

201

Тело ответа

Операция успешно создана. В теле ответа содержится ее описание SignOperation

Заголовки ответа

Название Описание
ETag Метка последнего изменения запроса

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

  HTTP 201
  ETag: 686897696a7c876b7e
{
  "signatureId": "3aad391b-6995-4074-a2ff-46c7a1dd234e",
  "certificateId": "70f78249-dc69-450f-ab38-19974a310020",
  "creationDate": "2011-01-01T15:03:01.012345Z",
  "state" : "Processing",
  "contentInfo":
  [
    {
      "content":
      {
        "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
        "contentType":"pdf",
        "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
      }
    }
  ]
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание Содержимое контекста
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
AbsenceOfRequiredField Не указано одно из обязательных полей
UnexistentCertificate Не удалось найти указанный сертификат
UnexistentContent Не удалось найти контент в базе по указанному идентификатору Описание ненайденного контента ContetnIfo
DuplicatedExternalId Указанный в запросе внешний идентификатор уже был использован ранее

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

  HTTP 400
  Content-Type Application/json
  {
      "code": "validation",
      "message": "Failed to validate request",
      "target": "api"
      "errors":
      [
        {
          "code": "DuplicatedExternalId",
          "message": "ExternalId" 978a9fda-e2e8-415d-bf25-31487ffb8bf1 is already in used",
          "target": "CryptoApi"
        }
      ]
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода