Универсальный API Dokobit

Универсальный API Dokobit — это универсальное средство, которое позволяет подписывать документы внутри системы и собирать подписи от 3-х сторон за пределами вашей системы по всей Европе. Подписывание документов происходит в подписи Dokobit без учетной записи (где приглашенные участники могут подписывать документы без регистрации на портале Dokobit) с фирменной символикой вашей организации.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Dokobit
URL	https://support.dokobit.com
Адрес электронной почты	developers@dokobit.com

Метаданные соединителя
Publisher	Dokobit
Веб-сайт	https://www.dokobit.com/solutions
Политика конфиденциальности	https://www.dokobit.com/compliance/privacy-policy
Категории	Продуктивность

Универсальный API Dokobit — это универсальное средство, которое позволяет подписывать документы внутри системы и собирать подписи от 3-х сторон за пределами вашей системы по всей Европе. Подписывание документов происходит в подписи Dokobit без учетной записи (где приглашенные участники могут подписывать документы без регистрации на портале Dokobit) с фирменной символикой вашей организации.

Предпосылки

Чтобы использовать универсальный API Dokobit, обратитесь к нам, sales@dokobit.com чтобы получить маркер доступа к API.

Получение учетных данных

Обратитесь к нашим продажам, чтобы получить маркер доступа к API

Начало работы с соединителем

• Подписывание документов можно инициировать с помощью действий DokobitUniversalAPICreateExternalSigning или DokobitUniversalAPICreateInternalSigning. Используя DokobitUniversalAPICreateExternalSigning, отправьте участникам приглашение на подпись. DokobitUniversalAPICreateInternalSigning создаст URL-адрес подписи, где пользователи могут быть перенаправлены.
• Затем подписывание можно управлять соответствующими действиями, позволяющими добавлять и удалять участников, отправлять напоминания или проверять состояние подписи документа.
• После подписания документа его можно скачать с помощью действий DokobitUniversalAPIDownloadDocumentExternal или DokobitUniversalAPIDownloadDocumentInternal.

Известные проблемы и ограничения

Текущая реализация поддерживает сбор подписей в PDF-файлах и поддерживается контейнерами ASiCe, ADoc, BDoc или EDoc.

Распространенные ошибки и средства устранения неполадок

• Файл должен быть указан как содержимое файла в кодировке Base64.
• Если для подписи документа "Тип" задано значение "pdf", при инициировании подписи документа будет принято одно PDF-документ. Для нескольких файлов задайте для подписи "Тип" значение asice или другой формат контейнера.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Validation	Dokobit является поставщиком услуг, сертифицированным eIDAS, для квалифицированных проверок электронной подписи и электронных запечаток. Используйте это действие для отправки подписанного файла для проверки. Поддерживаемые типы файлов: asice, asics, bdocsce, edoc, pdf, p7s. xml
Добавление внешнего входа	Указанные участники получат доступ к документу с выбранной ролью.
Добавление внутреннего входа	Указанные участники получат доступ к документу с выбранной ролью.
Обновление внешнего подписывания	Позволяет обновлять атрибуты существующего подписывания документа.
Обновление внутренней подписи	Позволяет обновлять атрибуты существующего подписывания документа.
Отправка напоминания	Позволяет отправлять сообщение электронной почты напоминания для участника, только если пользователь еще не подписал документ. Работает только с внешним потоком подписывания.
Подпись печати	Документ будет запечатан электронным печатью вашей организации. Обратитесь в developers@dokobit.com нашу службу поддержки, чтобы получить квалифицированный сертификат для запечатывания электронной почты.
Проверка состояния внешнего подписывания	Возвращает сведения о документе с состоянием подписи.
Проверка состояния внутренней подписи	Возвращает сведения о документе с состоянием подписи.
Проверка — PDF-отчет	Скачайте отчет проверки в ФОРМАТЕ PDF.
Проверка — XML-отчет	Скачайте отчет проверки в ФОРМАТЕ XML.
Проверка — данные диагностики XML	Скачайте диагностические данные в XML.
Проверка — подробный PDF-отчет	Скачайте подробный отчет о проверке в ФОРМАТЕ PDF.
Скачивание внешнего документа	Загружает подписанный документ.
Скачивание внутреннего документа	Загружает подписанный документ.
Создание внешней подписи	Внешняя подпись инициирует асинхронный запрос подписи из системы. В этом случае пользователь получает сообщение электронной почты для подписания, и вы получите обратный вызов после того, как он подписывает документ.
Создание внутренней подписи	Внутренняя подпись инициирует запрос на подписи из системы. В этом случае создается URL-адрес подписывания, в котором должен быть перенаправлен участник.
Удаление внешнего подписывания	Документ будет удален из учетной записи владельца. Он останется доступным для других участников.
Удаление внешнего подписывателя	Доступ к документу будет отменен для указанного участника.
Удаление внутреннего входа	Доступ к документу будет отменен для указанного участника.
Удаление внутренней подписи	Документ будет удален из учетной записи владельца. Он останется доступным для других участников.
электронная доставка	Электронная доставка документов используется для безопасного совместного доступа к документам с помощью Универсального API Dokobit.

Validation

Идентификатор операции:

DokobitUniversalAPIValidation

Dokobit является поставщиком услуг, сертифицированным eIDAS, для квалифицированных проверок электронной подписи и электронных запечаток. Используйте это действие для отправки подписанного файла для проверки. Поддерживаемые типы файлов: asice, asics, bdocsce, edoc, pdf, p7s. xml

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	name	True	string	Имя файла.
Content	content	True	string	Содержимое файла в кодировке Base64.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние отправки	status	string	Состояние отправки.
Маркер проверки	token	string	Маркер проверки.

Добавление внешнего входа

Идентификатор операции:

DokobitUniversalAPIAddExternalSigner

Указанные участники получат доступ к документу с выбранной ролью.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Внешний идентификатор	external_id	True	string	Уникальный случайный идентификатор участника из системы. Вы можете создать уникальные случайные идентификаторы, если у вас его нет.
Имя	name		string	Имя участника.
Surname	surname		string	Фамилия участника.
Эл. почта	email		string	Электронная почта участника.
Code	code		string	Код участника.
Код страны	country_code		string	Код страны участника. Требуется, если предоставлен личный код. Доступные значения: LT, LV, ISEEFINO, . SEBE
Role	role		string	Роль участника. Доступные значения: signer, viewer. По умолчанию: signer.
Компания	company		string	Компания участника.
Position	position		string	Позиция участника.
Телефон	phone		string	Телефон участника.
Настраиваемая причина	custom_reason		string	Причина пользовательской подписи.
Язык уведомлений	notifications_language		string	Задает язык уведомлений. Доступные значения: en, lvisltdesefinofret, ; dknl
Страница	page		string	Индекс страницы для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция сверху	top		string	Позиция (в точках) сверху для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция слева	left		string	Позиция (в точках) слева от видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Language	language		string	Язык видимой заметки подписи PDF. Применимо только для подписывания типов PDF. Доступные значения: en, , etltlvis
Комментарий	comment		string	Сообщение для участников.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Подписыватели	signers	array of object	Сведения участника.
Внешний идентификатор	signers.external_id	string	Уникальный случайный идентификатор участника из системы.
Токен	signers.token	string	Токен участника.
Имя	signers.name	string	Имя участника.
Surname	signers.surname	string	Фамилия участника.
Эл. почта	signers.email	string	Электронная почта участника.
Code	signers.code	string	Личный код участника (номер национального идентификатора).
Код страны	signers.country_code	string	Страна участника.
Role	signers.role	string	Роль участника.
Компания	signers.company	string	Компания участника.
Position	signers.position	string	Позиция участника.
Язык уведомлений	signers.notifications_language	string	Задает язык уведомлений. Доступные значения: en, lvisltetnofr, 'se', 'de'.
Телефон	signers.phone	string	Телефон участника.

Добавление внутреннего входа

Идентификатор операции:

DokobitUniversalAPIAddInternalSigner

Указанные участники получат доступ к документу с выбранной ролью.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Внешний идентификатор	external_id	True	string	Уникальный случайный идентификатор участника из системы. Вы можете создать уникальные случайные идентификаторы, если у вас его нет.
Role	role		string	Роль участника. Доступные значения: signer, viewer. По умолчанию: signer.
Code	code		string	Код участника.
Код страны	country_code		string	Код страны участника. Требуется, если предоставлен личный код. Доступные значения: LT, LV, ISPLNOFIEE, . SEBE
Телефон	phone		string	Телефон участника.
Язык уведомлений	language		string	Задает язык пользовательского интерфейса. Доступные значения: en, lvisltdesefinofret, ; dknl
Страница	page		string	Индекс страницы для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция сверху	top		string	Позиция (в точках) сверху для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция слева	left		string	Позиция (в точках) слева от видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Language	language		string	Язык видимой заметки подписи PDF. Применимо только для подписывания типов PDF. Доступные значения: en, , etltlvis
Настраиваемая причина	custom_reason		string	Причина пользовательской подписи.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Подписыватели	signers	array of object	Сведения участника.
Внешний идентификатор	signers.external_id	string	Уникальный случайный идентификатор участника из системы.
Токен	signers.token	string	Токен участника.
Имя	signers.name	string	Имя участника.
Surname	signers.surname	string	Фамилия участника.
Эл. почта	signers.email	string	Электронная почта участника.
Code	signers.code	string	Личный код участника (номер национального идентификатора).
Код страны	signers.country_code	string	Страна участника.
Role	signers.role	string	Роль участника.
Компания	signers.company	string	Компания участника.
Position	signers.position	string	Позиция участника.
Телефон	signers.phone	string	Телефон участника.

Обновление внешнего подписывания

Идентификатор операции:

DokobitUniversalAPIUpdateExternalSigning

Позволяет обновлять атрибуты существующего подписывания документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Deadline	deadline		date-time	Подписывание даты крайнего срока с указанным фрагментом часового пояса. Пример: 2018-11-05T13:15:30Z.
Трудный срок	hard_deadline		boolean	Если задано для true участников, после установки deadlineэтот документ не сможет подписать или утвердить этот документ. По умолчанию: false.
Требовать квалифицированные подписи	require_qualified_signatures		boolean	Разрешить подписывать только с помощью квалифицированных подписей. По умолчанию: false.
Разрешить идентификацию видео	allow_video_identification		boolean	Разрешить подписывать с помощью идентификации на основе видео. По умолчанию: false.
Разрешить сохранение документов	allow_document_saving		boolean	Разрешить пользователю сохранять документ на портале Dokobit и выполнять дальнейшие действия. По умолчанию: true.
Разрешенные методы подписывания	allowed_signing_methods		array of string	Разрешить только определенные методы подписывания. Доступные значения: mobile, smartcardsmartideparaksts_mobilebankid_nobankid_seaudkenni_appftnmitidelectronic_iditsmeidinswisscomsms_otp

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Обновление внутренней подписи

Идентификатор операции:

DokobitUniversalAPIUpdateInternalSigning

Позволяет обновлять атрибуты существующего подписывания документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Требовать квалифицированные подписи	require_qualified_signatures		boolean	Разрешить подписывать только с помощью квалифицированных подписей. По умолчанию: false.
Разрешить идентификацию видео	allow_video_identification		boolean	Разрешить подписывать с помощью идентификации на основе видео. По умолчанию: false.
Разрешенные методы подписывания	allowed_signing_methods		array of string	Разрешить только определенные методы подписывания. Доступные значения: mobile, smartcardsmartideparaksts_mobilebankid_nobankid_seaudkenni_appftnmitidelectronic_iditsmeidinswisscomsms_otp

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Отправка напоминания

Идентификатор операции:

DokobitUniversalAPIReminder

Позволяет отправлять сообщение электронной почты напоминания для участника, только если пользователь еще не подписал документ. Работает только с внешним потоком подписывания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Токен подписи	signer	True	string	Токен участника.
Message	message		string	Сообщение напоминания для подписывателя.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Подпись печати

Идентификатор операции:

DokobitUniversalAPISealSigning

Документ будет запечатан электронным печатью вашей организации. Обратитесь в developers@dokobit.com нашу службу поддержки, чтобы получить квалифицированный сертификат для запечатывания электронной почты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Настраиваемая причина	custom_reason		string	Причина пользовательской подписи.
Страница	page		string	Индекс страницы для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция сверху	top		string	Позиция (в точках) сверху для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция слева	left		string	Позиция (в точках) слева от видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Проверка состояния внешнего подписывания

Идентификатор операции:

DokobitUniversalAPICheckExternalSigningStatus

Возвращает сведения о документе с состоянием подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние подписи	status	string	Состояние подписи документа.
Имя	name	string	Имя подписи, отображаемое для пользователя.
Тип	type	string	Тип документа.
Дата создания	date_created	string	Дата начала подписывания документа.
Deadline	deadline	date-time	Подписывание даты крайнего срока с указанным фрагментом часового пояса. Пример: 2018-11-05T13:15:30Z.
Имя файла	filename	string	Имя файла.
Files	files	array of object
Имя	files.name	string	Имя файла.
URL-адрес скачивания	files.url	string	URL-адрес скачивания файла.
Тип MIME	files.mime_type	string	Тип MIME файла.
Подписыватели	signers	array of object	Сведения о участниках.
Токен	signers.token	string	Токен участника.
Имя	signers.first_name	string	Имя участника.
Surname	signers.last_name	string	Фамилия участника.
Code	signers.code	string	Код участника.
Страна	signers.country	string	Страна участника.
Эл. почта	signers.email	string	Электронная почта участника.
Тип	signers.type	string	Тип.
Состояние	signers.status	string	Состояние участника.

Проверка состояния внутренней подписи

Идентификатор операции:

DokobitUniversalAPICheckInternalSigningStatus

Возвращает сведения о документе с состоянием подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние подписи	status	string	Состояние подписи документа.
Имя	name	string	Имя подписи, отображаемое для пользователя.
Тип	type	string	Тип документа.
Дата создания	date_created	string	Дата начала подписывания документа.
Deadline	deadline	date-time	Подписывание даты крайнего срока с указанным фрагментом часового пояса. Пример: 2018-11-05T13:15:30Z.
Имя файла	filename	string	Имя файла.
Files	files	array of object
Имя	files.name	string	Имя файла.
URL-адрес скачивания	files.url	string	URL-адрес скачивания файла.
Тип MIME	files.mime_type	string	Тип MIME файла.
Подписыватели	signers	array of object	Сведения о участниках.
Токен	signers.token	string	Токен участника.
Имя	signers.first_name	string	Имя участника.
Surname	signers.last_name	string	Фамилия участника.
Code	signers.code	string	Код участника.
Страна	signers.country	string	Страна участника.
Эл. почта	signers.email	string	Электронная почта участника.
Тип	signers.type	string	Тип.
Состояние	signers.status	string	Состояние участника.

Проверка — PDF-отчет

Идентификатор операции:

DokobitUniversalAPIValidationPDFReport

Скачайте отчет проверки в ФОРМАТЕ PDF.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Маркер проверки	token	True	string	Маркер проверки, полученный от действия DokobitUniversalAPIValidation.

Возвращаемое значение

response

object

Проверка — XML-отчет

Идентификатор операции:

DokobitUniversalAPIValidationXMLReport

Скачайте отчет проверки в ФОРМАТЕ XML.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Маркер проверки	token	True	string	Маркер проверки, полученный от действия DokobitUniversalAPIValidation.

Возвращаемое значение

response

object

Проверка — данные диагностики XML

Идентификатор операции:

DokobitUniversalAPIValidationXMLDiagnosticData

Скачайте диагностические данные в XML.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Маркер проверки	token	True	string	Маркер проверки, полученный от действия DokobitUniversalAPIValidation.

Возвращаемое значение

response

object

Проверка — подробный PDF-отчет

Идентификатор операции:

DokobitUniversalAPIValidationDetailedPDFReport

Скачайте подробный отчет о проверке в ФОРМАТЕ PDF.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Маркер проверки	token	True	string	Маркер проверки, полученный от действия DokobitUniversalAPIValidation.

Возвращаемое значение

response

object

Скачивание внешнего документа

Идентификатор операции:

DokobitUniversalAPIDownloadDocumentExternal

Загружает подписанный документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

response

object

Скачивание внутреннего документа

Идентификатор операции:

DokobitUniversalAPIDownloadDocumentInternal

Загружает подписанный документ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

response

object

Создание внешней подписи

Идентификатор операции:

DokobitUniversalAPICreateExternalSigning

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип	type	True	string	Формат документа. Доступные значения: pdf, , edocasicebdoc, adoc, adoc.cedoc.
Имя	name	True	string	Имя подписи, отображаемое для пользователя.
URL-адрес обратной передачи	postback_url		string	URL-адрес системы для обработки веб-перехватчиков.
Deadline	deadline		date-time	Подписывание даты крайнего срока с указанным фрагментом часового пояса. Пример: 2018-11-05T13:15:30Z.
Трудный срок	hard_deadline		boolean	Если задано для true участников, после установки deadlineэтот документ не сможет подписаться. По умолчанию: false.
Требовать квалифицированные подписи	require_qualified_signatures		boolean	Разрешить подписывать только с помощью квалифицированных подписей. По умолчанию: false.
Позиция заметки	annotation_position		string	Вы можете выбрать позицию заметок подписи в PDF-документе. Доступные значения: first_top, , first_bottomlast_top, nonelast_bottom. По умолчанию: first_top.
Личный код заметки	annotation_personal_code		boolean	Если задано значение "Личный true код", он будет отображаться в заметке. Применимо только для подписывания типов PDF. По умолчанию: false.
Комментарий	comment		string	Сообщение для участников.
Разрешить идентификацию видео	allow_video_identification		boolean	Разрешить подписывать с помощью идентификации на основе видео. По умолчанию: false.
Разрешить сохранение документов	allow_document_saving		boolean	Разрешить пользователю сохранять документ на портале Dokobit и выполнять дальнейшие действия. По умолчанию: true.
Плоский PDF-файл	flatten_pdf		boolean	Если задано значение true, документ будет выровнен таким образом, чтобы поля формы стали частью содержимого документа и не могут быть изменены после подписания. Применимо только для подписывания типов PDF. По умолчанию: false.
Разрешенные методы подписывания	allowed_signing_methods		array of string	Разрешить только определенные методы подписывания. Доступные значения: mobile, smartcardsmartideparaksts_mobilebankid_nobankid_seaudkenni_appftnmitidelectronic_iditsmeidinswisscomsms_otp
Имя	name	True	string	Имя файла.
Content	content	True	string	Содержимое файла в кодировке Base64.
Внешний идентификатор	external_id	True	string	Уникальный случайный идентификатор участника из системы. Вы можете создать уникальные случайные идентификаторы, если у вас его нет.
Имя	name		string	Имя участника.
Surname	surname		string	Фамилия участника.
Эл. почта	email		string	Электронная почта участника.
Code	code		string	Личный код участника (номер национального идентификатора).
Код страны	country_code		string	Код страны участника. Требуется, если предоставлен личный код. Доступные значения: LT, LV, ISEEFINO, . SEBE
Role	role		string	Роль участника. Доступные значения: signer, viewer. По умолчанию: signer.
Компания	company		string	Имя компании участника.
Position	position		string	Позиция участника.
Телефон	phone		string	Номер телефона участника.
Последовательность	sequence		integer	Позволяет настроить порядок последовательности утверждений и подписывания документов.
Язык уведомлений	notifications_language		string	Задает язык уведомлений. Доступные значения: en, lvisltdesefinofret, ; dknl
Настраиваемая причина	custom_reason		string	Причина пользовательской подписи.
Страница	page		string	Индекс страницы для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция сверху	top		string	Позиция (в точках) сверху для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция слева	left		string	Позиция (в точках) слева от видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Language	language		string	Язык видимой заметки подписи PDF. Применимо только для подписывания типов PDF. Доступные значения: en, , etltlvis

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Токен подписывания	token	string	Токен подписывания.
Подписыватели	signers	array of object	Сведения участника.
Внешний идентификатор	signers.external_id	string	Уникальный случайный идентификатор участника из системы.
Токен	signers.token	string	Токен участника.
Имя	signers.first_name	string	Имя участника.
Surname	signers.last_name	string	Фамилия участника.
Code	signers.code	string	Личный код участника (номер национального идентификатора).
Страна	signers.country	string	Страна участника.
Эл. почта	signers.email	string	Электронная почта участника.

Создание внутренней подписи

Идентификатор операции:

DokobitUniversalAPICreateInternalSigning

Внутренняя подпись инициирует запрос на подписи из системы. В этом случае создается URL-адрес подписывания, в котором должен быть перенаправлен участник.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип	type	True	string	Формат документа. Доступные значения: pdf, , edocasicebdoc, adoc, adoc.cedoc.
Имя	name	True	string	Имя подписи, отображаемое для пользователя.
Перенаправляющий URI	redirect_uri	True	string	URI перенаправления, который будет использоваться для перенаправления подписи после завершения подписи.
URL-адрес обратной передачи	postback_url		string	URL-адрес системы для обработки веб-перехватчиков.
Требовать квалифицированные подписи	require_qualified_signatures		boolean	Разрешить подписывать только с помощью квалифицированных подписей. По умолчанию: false.
Позиция заметки	annotation_position		string	Вы можете выбрать позицию заметок подписи в PDF-документе. Доступные значения: first_top, , first_bottomlast_top, nonelast_bottom. По умолчанию: first_top.
Личный код заметки	annotation_personal_code		boolean	Если задано значение "Личный true код", он будет отображаться в заметке. Применимо только для подписывания типов PDF. По умолчанию: false.
Разрешить идентификацию видео	allow_video_identification		boolean	Разрешить подписывать с помощью идентификации на основе видео. По умолчанию: false.
Плоский PDF-файл	flatten_pdf		boolean	Если задано значение true, документ будет выровнен таким образом, чтобы поля формы стали частью содержимого документа и не могут быть изменены после подписания. Применимо только для подписывания типов PDF. По умолчанию: false.
Разрешенные методы подписывания	allowed_signing_methods		array of string	Разрешить только определенные методы подписывания. Доступные значения: mobile, smartcardsmartideparaksts_mobilebankid_nobankid_seaudkenni_appftnmitidelectronic_iditsmeidinswisscomsms_otp
Имя	name	True	string	Имя файла.
Content	content	True	string	Содержимое файла в кодировке Base64.
Внешний идентификатор	external_id	True	string	Уникальный случайный идентификатор участника из системы. Вы можете создать уникальные случайные идентификаторы, если у вас его нет.
Role	role		string	Роль участника. Доступные значения: signer, viewer. По умолчанию: signer.
Code	code		string	Код участника.
Код страны	country_code		string	Код страны участника. Требуется, если предоставлен личный код. Доступные значения: LT, LV, ISPLNOFIEE, . SEBE
Телефон	phone		string	Телефон участника.
Язык уведомлений	language		string	Задает язык пользовательского интерфейса. Доступные значения: en, lvisltdesefinofret, ; dknl
Страница	page		string	Индекс страницы для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция сверху	top		string	Позиция (в точках) сверху для видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Позиция слева	left		string	Позиция (в точках) слева от видимой заметки подписи PDF. Применимо только для подписывания типов PDF. По умолчанию: 1.
Language	language		string	Язык видимой заметки подписи PDF. Применимо только для подписывания типов PDF. Доступные значения: en, , etltlvis
Настраиваемая причина	custom_reason		string	Причина пользовательской подписи.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Токен подписывания	token	string	Токен подписывания.
Подписыватели	signers	array of object	Сведения участника.
Внешний идентификатор	signers.external_id	string	Уникальный случайный идентификатор участника из системы.
Токен	signers.token	string	Токен участника.
Перенаправляющий URI	signers.redirect_uri	string	URL-адрес подписывания.

Удаление внешнего подписывания

Идентификатор операции:

DokobitUniversalAPIDeleteExternalSigning

Документ будет удален из учетной записи владельца. Он останется доступным для других участников.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Удаление внешнего подписывателя

Идентификатор операции:

DokobitUniversalAPIDeleteExternalSigner

Доступ к документу будет отменен для указанного участника.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Токен	token	True	string	Токен участника.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Удаление внутреннего входа

Идентификатор операции:

DokobitUniversalAPIDeleteInternalSigner

Доступ к документу будет отменен для указанного участника.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.
Токен	token	True	string	Токен участника.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Удаление внутренней подписи

Идентификатор операции:

DokobitUniversalAPIDeleteInternalSigning

Документ будет удален из учетной записи владельца. Он останется доступным для других участников.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен подписывания	token	True	string	Токен подписывания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

электронная доставка

Идентификатор операции:

DokobitUniversalAPIeDelivery

Электронная доставка документов используется для безопасного совместного доступа к документам с помощью Универсального API Dokobit.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип	type	True	string	Формат документа. Доступные значения: pdf.
Имя	name	True	string	Имя документа, отображаемое для пользователя.
URL-адрес обратной передачи	postback_url		string	URL-адрес системы для обработки веб-перехватчиков.
Комментарий	comment		string	Сообщение для получателей.
Имя	name	True	string	Имя файла.
Content	content	True	string	Содержимое файла в кодировке Base64.
Внешний идентификатор	external_id	True	string	Уникальный случайный идентификатор участника из системы. Вы можете создать уникальные случайные идентификаторы, если у вас его нет.
Code	code	True	string	Личный код получателя (номер национального идентификатора).
Код страны	country_code	True	string	Код страны получателя. Требуется, если предоставлен личный код. Доступные значения: lt, , islvee.
Эл. почта	email		string	Электронная почта получателя для отправки документа. Требуется, если телефон не задан.
Телефон	phone		string	Номер телефона получателя для отправки SMS документов. Требуется, если электронная почта не задана. SMS будет отправляться только в том случае, если адрес электронной почты не указан.
Язык уведомлений	notifications_language		string	Задает язык уведомлений. Доступные значения: en, lvisltetnofr, 'se', 'de'.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Маркер документа	token	string	Маркер документа.
Получатели	recipients	array of object	Сведения получателя.
Внешний идентификатор	recipients.external_id	string	Уникальный случайный идентификатор участника из системы.
Токен	recipients.token	string	Маркер получателя.
Code	recipients.code	string	Личный код получателя (номер национального идентификатора).
Страна	recipients.country	string	Страна получателя.
Эл. почта	recipients.email	string	Электронная почта получателя.

Определения

объект

Это тип object.