CryptoEvent

Объект CryptoEvent содержит описание актуального события, которое произошло с сертификатом.

Название Тип Формат Обязательность Описание
eventId string Guid true Идентификатор события
eventDate date-time ISO 8601: YYYY-MM-DDTHH:MM.S& true Дата возниконвения события
certificateId string Guid true Идентификатор формы на сертификат
externalId string ^\w{1,256}$ false Пользовательский идентификатор формы
certificateFormEvent string CertificateFormEvent false Описание события, которое произошло при выпуске сертификата
CertificateEvent string CertificateEvent false Описание события, которое произошло с действующим сертификатом
signEvent string SignEvent false Описание события, которое произошло при подписании документов сертификатом

В объекте может содержаться одно из событий:

  • CertificateFormEvent;
  • CertificateEvent;
  • SignEvent.

Если сертификат находится в процессе выпуска, то события будут описаны в объекте CertificateFormEvent. В этом случае событие для сертификата будет возникать, когда:

  • данные в форме на выпуск сертификата не прошли проверку. Описание ошибок будет собержаться в объекте CertificateFormEvent: error.
  • по форме выпущен сертификат. В событии будет содержаться информация о сертификате CertificateFormEvent: certificate и расписке в получении сертификата CertificateFormEvent: receipt, которую необходимо подписать.

Если сертификат уже выпущен, то изменения связанные с действующим сертификатом будут описаны в объекте CertificateEvent. В этом случае событие для сертификата будет возникать, если он отозван или срок его действия приостановлен.

Если сертификат уже выпущен и с его участием происходит подписание, то события будут описаны в объекте SignEvent. В этом случае событие для сертификата будет возникать, когда подписание требует подписи владельца или оно завершилось.

CertificateFormEvent

Объект CertificateFormEvent содержит описание события, которое прозошло при выпуске сертификата.

Название Тип Формат Обязательность Описание
formState string FormState true Статус формы на выпуск сертификата
certificate object ContentInfo false Описание сертификата
receipt object ContentInfo false Расписка в получении сертификата
error object Error false Описание ошибки

Примеры:

  1. Сертификат выпущен
{
    "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
    "eventDate": "2011-01-01T15:03:01.012345Z",
    "certificateId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
    "certificateFormEvent":
    {
      "formState": "Released",
      "certificate":
      {
        "contentId": "cb351abb-36fb-43be-9194-639be38b5617",
        "contentType":"cer",
        "md5":"F7415E33F972C03ABD4F3FED36748F7A"
      },
      "receipt":
      {
        "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
        "contentType":"pdf",
        "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
      }
    }
  }
  1. Данные в форме на выпуск сертификата не прошли проверку
{
  "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
  "eventDate": "2011-01-01T15:03:01.012345Z",
  "certificateId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
  "certificateFormEvent":
  {
    "formState": "ValidationError",
    "error":
    [
      {
        "code": "Validation",
        "message": "can't validate form data",
        "target": "cryptoAPI",
        "errors":
        {
          "code": "SmevValidationError",
          "message":"СНИЛС не соответствует данным",
          "target":"cryptoAPI"
        }
      }
    ]
  }
}

CertificateEvent

Объект CertificateEvent содержит описание события, которое прозошло с действующим сертификатом.

Название Тип Формат Обязательность Описание
certificateState string СertificateState true Статус сертификата
certificate object СertificateInfo false Описание сертификата

Примеры:

  1. Сертификат отозван
{
    "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
    "eventDate": "2011-01-01T15:03:01.012345Z",
    "certificateId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
    "certificateEvent":
    {
      "certificateState": "Released",
      "certificate":
      {
        "Id": "b7b4a90e-efc4-4988-8a58-16dac7195215",
        "certificateState": "Valid",
        "data":
        {
          "contentId": "cb351abb-36fb-43be-9194-639be38b5617",
          "contentType":"pdf",
          "md5":"F7415E33F972C03ABD4F3FED36748F7A"
        },
        "validFrom": "2019-06-25",
        "validTo": "2020-06-25"
      }
    }
  }

SignEvent

Объект CertificateFormEvent содержит описание события, которое прозошло при подписании документов сертификатом.

Название Тип Формат Обязательность Описание
signatureId string Guid true Идентификатор подписания
externalId string ^\w{1,256}$ false Пользовательский идентификатор подписания
signState object SignState true Статус подписания
signedFiles object Content false Подписанные файлы

Примеры:

  1. Подписание документов сертификатом завершилось успешно
{
  "lastEventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
  "events":
  [
    {
      "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
      "eventDate": "2011-01-01T15:03:01.012345Z",
      "certificateId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
      "signEvent":
      {
        "signatureId": "3aad391b-6995-4074-a2ff-46c7a1dd234e",
        "signState": "Processed",
        "signedFiles":
        {
          "contentInfo":
          {
            "contentId": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
            "contentType":"pdf",
            "contentName": "Договор купли-продажи",
            "md5":"7E0D44C48AF788657EA6F5C4C87589E8"
          },
          "signatures":
          [
            {
              "contentId": "c6780dbc-126b-44f6-9f7b-7422609d8ebb",
              "contentType":"sig",
              "md5":"F7415E33F972C03ABD4F3FED36748F7A"
            }
          ]
        }
      }
    }
  ]
}
  1. Подписание документов сертификатом завершилось отменой
{
  "eventId": "5a8c791a-6404-4cda-b3f8-f5ec45cd685b",
  "eventDate": "2011-01-01T15:03:01.012345Z",
  "certificateId": "1f3ba8ad-b868-46f2-9088-56aa2753bc88",
  "signEvent":
  {
    "signatureId": "3aad391b-6995-4074-a2ff-46c7a1dd234e",
    "signState": "Canceled"
  }
}