-
Notifications
You must be signed in to change notification settings - Fork 0
SignedContent
message SignedContent {
optional bytes Content = 1;
optional bytes Signature = 2;
optional bool SignByAttorney = 3 [default = false];
optional string NameOnShelf = 4;
optional bool SignWithTestSignature = 5 [default = false];
}
Структура данных SignedContent служит для представления подписанных ЭЦП данных в отправляемом сообщении:
-
Content - подписываемые данные (бинарное представление документа). Должно оставаться пустым (не заполняться), если заполнено поле NameOnShelf.
-
NameOnShelf - имя файла с подписываемыми данными на «полке документов». Должно оставаться пустым (не заполняться), если содержимое подписанного документа размещено в поле Content.
-
Signature - ЭЦП (в некоторых случаях может отсутствовать). Если ЭЦП присутствует, то она должна быть представлена в формате CMS SignedData в DER-кодировке.
-
SignByAttorney - флаг, который позволяет запросить формирование ЭЦП под пересылаемыми данными «по доверенности».
-
SignWithTestSignature - флаг, который позволяет запросить формирование тестовой ЭЦП под пересылаемыми данными.
Значения полей в данной структуре обязаны быть согласованы следующим образом:
-
SignWithTestSignature = false, SignByAttorney = false: типовая ситуация формирования структуры SignedContent для подписываемого документа; в этом случае ЭЦП обязана присутствовать в поле Signature;
-
SignWithTestSignature = true, SignByAttorney = false: для документа запрашивается формирование тестовой подписи; в этом случае поле Signature должно оставаться пустым.
-
SignWithTestSignature = false, SignByAttorney = true: для документа запрашивается формирование ЭЦП «по доверенности» (подпись будет добавлена позже); в этом случае поле Signature должно оставаться пустым.
-
SignWithTestSignature = true, SignByAttorney = true: недопустимая комбинация флагов; не должна использоваться.
Следует придерживаться следующей схемы использования структуры SignedContent. Если подписываемый документ имеет небольшой размер (не превышает 500Кб), его бинарное представление можно разместить непосредственно в структуре SignedContent в поле Content. Если же размер документа не укладывается в эти ограничения, следует предварительно загрузить этот документ на «полку документов» при помощи серии вызовов ShelfUpload, а затем указать имя документа на «полке» в поле NameOnShelf структуры SignedContent. В противном случае сервер может отказаться обрабатывать запрос, содержащий структуры SignedContent большого размера.
Вообще говоря, ограничения на размер передаваемых документов действуют не только на уровне отдельного документа, но и на уровне запроса к серверу. А именно, если запрос к серверу содержит несколько документов (несколько структур SignedContent), то суммарный размер передаваемых в рамках запроса данных не должен превышать 5Мб (с учетом передаваемой служебной информации). Поэтому для повышения устойчивости интеграционного решения использование загрузки документов через сервис «полки документов» является рекомендуемым.
Все возникающие вопросы, связанные с интеграцией вашей системы с Диадоком, можно задавать на форуме либо в почту [email protected].
История изменений Diadoc API Обзор возможностей API
- Порядок работы клиента API при организации документооборота
- Модель данных
- Управление списком активных контрагентов
- Неформализованный документооборот
- Документооборот электронных счетов-фактур
- Дополнительные функции API
- Возможности для интеграции
- Авторизация
- Docflow API
- Облачная подпись
-
Поддерживаемые операции
- AcquireCounteragent
- Authenticate
- BreakWithCounteragent
- CanSendInvoice
- Delete
- ForwardDocument
- GenerateAcceptanceCertificateXmlForBuyer
- GenerateAcceptanceCertificateXmlForSeller
- GenerateDocumentProtocol
- GenerateDocumentZip
- GenerateForwardedDocumentProtocol
- GenerateInvoiceXml
- GenerateInvoiceCorrectionRequestXml
- GenerateInvoiceDocumentReceiptXml
- GeneratePrintForm
- GenerateTorg12XmlForSeller
- GenerateTorg12XmlForBuyer
- GenerateRevocationRequestXml
- GenerateSignatureRejectionXml
- GetBox
- GetCounteragent
- GetCounteragents
- GetDocument
- GetDocuments
- GetEntityContent
- GetEvent
- GetExternalServiceAuthInfo
- GetForwardedDocuments
- GetForwardedDocumentEvents
- GetForwardedEntityContent
- GetInvoiceCorrectionRequestInfo
- GetMessage
- GetMyOrganizations
- GetMyPermissions
- GetMyUser
- GetNewEvents
- GetOrganization
- GetOrganizationUsers
- GetOrganizationsByInnKpp
- GetRecognized
- MoveDocuments
- ParseAcceptanceCertificateSellerTitleXml
- ParseRevocationRequestXml
- ParseSignatureRejectionXml
- ParseInvoiceXml
- ParseTorg12SellerTitleXml
- ParseRussianAddress
- PostMessage
- PostMessagePatch
- PrepareDocumentsToSign
- Recognize
- RecycleDraft
- Restore
- SendDraft
- ShelfUpload
- ShelfDownload
-
Структуры данных
- AcceptanceCertificateAttachment
- AcceptanceCertificateInfo
- Address
- AsyncMethodResult
- BasicDocumentAttachment
- BilateralDocumentMetadata
- BoxEvent
- BoxEventList
- Content
- Content_v2
- ContractAttachment
- Counteragent
- CustomDataItem
- CustomDataPatch
- Department
- Document
- DocumentId
- DocumentList
- DocumentProtocol
- DocumentSignature
- DocumentSenderSignature
- DocumentsMoveOperation
- DocumentType
- DocumentZipGenerationResult
- DraftToSend
- [Entity](Entity message)
- ExternalServiceAuthInfo
- ForwardDocumentEvent
- ForwardedDocument
- InvoiceCorrectionInfo
- InvoiceCorrectionRequestInfo
- InvoiceDocumentMetadata
- InvoiceInfo
- Message
- MessagePatch
- MessagePatchToPost
- MessageToPost
- NonformalizedAttachment
- NonformalizedDocumentMetadata
- Official
- Organization
- OrganizationInfo
- OrganizationUser
- OrganizationUserPermissions
- PrepareDocumentsToSignRequest
- PrepareDocumentsToSignResponse
- PriceListAttachment
- Recognized
- ReconciliationActAttachment
- Resolution
- ResolutionRequest
- ResolutionRequestDenial
- ResolutionStatus
- RevocationRequestInfo
- RoamingNotification
- ServiceDetailsAttachment
- SignatureRejectionInfo
- SignatureVerificationResult
- SignedContent
- Signer
- StructuredDataAttachment
- TimeBasedFilter
- Timestamp
- Torg12Info
- Torg13Attachment
- TrustConnectionRequestAttachment
- UnilateralDocumentMetadata
- User
- XmlDocumentAttachment
- .NET/COM-библиотека