Taktikal Core (предварительная версия)

С помощью Taktikal Core у вас есть возможность подписывать, запечатывать, проверять подлинность и получать подробные сведения о процессах подписывания.

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

Услуга	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)

Контакт
Имя	Taktikal
URL	https://docs.taktikal.com/
Адрес электронной почты	help@taktikal.com

Метаданные соединителя
Publisher	Taktikal
Website	https://taktikal.com/
Политика конфиденциальности	https://www.taktikal.com/privacy
Категории	Продуктивность

API-интерфейсы Taktikal Core — это эффективный способ создания новых решений в собственном интерфейсе и интеграции с решениями, которые уже работают.

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

Предпосылки

Чтобы использовать API Taktikal Core, обратитесь к нашей группе sales@taktikal.is продаж, чтобы получить необходимые учетные данные API.

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

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

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

Основной api может получить документы, подписанные, пройти проверку подлинности с помощью идентификатора e-ID исландии и управлять всеми процессами подписывания.

Для проверки подлинности используется /Auth/Start, чтобы инициировать процесс проверки подлинности, а затем /Auth/Poll, чтобы проверить, является ли состояние проверки подлинности.
Чтобы подписать один вызов документа /management/sign for a single document and /management/sign/sequential для массовой подписи нескольких документов.
Чтобы получить подробный журнал о вызове процесса подписывания /подписывание/действие/{ProcessKey}.

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

Запросы должны иметь заголовок авторизации для базовой проверки подлинности. Это компанияKey и API-Key
На данный момент только квалифицированные подписи имеют исландийский e-id.
В формате PDF должна быть строка ab Base64.
Подписыватели должны иметь допустимый адрес электронной почты и номер мобильного телефона.

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

В настоящее время для подписи принимаются только PDF-файлы.

Часто задаваемые вопросы

Дополнительные сведения об API см. в разделе https://docs.taktikal.com

Запуск процесса подписывания — это один запрос POST. Чтобы начать процесс подписывания, требуется действительный PDF-документ и список подписей, которые должны подписать документ. Taktikal будет обрабатывать отображение документа для подписи, также если выбран параметр communicationDeliveryType, Taktikal отправит подписывание SMS или Email со ссылкой на подпись. После подписания документа все участники Taktikal отправят документ в соответствующие пути доставки, зарегистрированные.

FlowKey — это ключ, предоставляемый Taktikal. Этот ключ поможет Taktikal обработать этот запрос. Для некоторых flowKeys Taktikal будет заботиться о создании документа. Он также будет контролировать, где подписанный документ доставляется после подписания.

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

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


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

По умолчанию

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

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

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

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

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

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

Действия

Возвращает журнал действий для компании	Возвращает журнал действий для компании
Возвращает журнал действий для пользователя (электронной почты) за определенный период	Возвращает журнал действий для пользователя в течение периода.
Возвращает журнал действий для процесса подписывания	Получите журнал действий для процесса подписывания.
Возвращает процесс подписывания по processKey и signeeKey	Получите процесс подписывания по ключу процесса и signeeKey.
Запечатывает PDF-документ	Запечатывает предоставленный PDF-документ, предоставленный в виде строки base64.
Запечатывает XML-документ	Запечатывает предоставленный XML-документ, предоставленный в виде строки base64.
Запускает процесс проверки подлинности с использованием идентификатора e-id исландии для последовательной подписи	Аутентификация с помощью исландийского e-id может выполняться с помощью мобильного телефона или приложения Audkenni. Используя мобильный телефон: для параметра AuthenticationContextType должно быть задано значение "Sim", а номер телефона должен иметь номер мобильного телефона Ucelandic. Ssn игнорируется. Использование приложения Audkenni: Для параметра AuthenticationContextType должно быть задано значение App, а номер ssn должен иметь номер социального страхования Icdlandic. Номер телефона игнорируется.
Инициирует процесс проверки подлинности с помощью идентификатора e-id исландии	Аутентификация с помощью исландийского e-id может выполняться с помощью мобильного телефона или приложения Audkenni. Используя мобильный телефон: для параметра AuthenticationContextType должно быть задано значение "Sim", а номер телефона должен иметь номер телефона в Исландии. Ssn игнорируется. Использование приложения Audkenni: Для параметра AuthenticationContextType должно быть задано значение App, а номер ssn должен иметь номер социального страхования Icdlandic. Номер телефона игнорируется. flowKey всегда должен быть предоставлен и аккуссибен на портале Taktikal.
Обновление signee для данного ProcessKey и SigneeKey	Свойства signee можно обновить на основе предоставления ProcessKey и SigneeKey.
Отмена последовательного процесса подписывания	Отмените последовательный процесс подписи на основе заданного ключа последовательности. Пользователь (электронная почта) может быть предоставлен, который отменяет последовательный процесс.
Отмена процесса подписывания	Отмена процесса подписывания на основе заданного ключа процесса.
Проверяет состояние проверки подлинности для пользователя с помощью идентификатора исландийского e-id	После успешного ответа от /Auth/Start a AuthRequestId возвращается и используется для проверки завершения проверки подлинности. Если проверка подлинности завершена и выполнена успешно, объект клиента заполняется в зависимости от lookupType. Тип подстановки указывает тип информации, извлекаемой для Национального реестра Исландии. Существует три разных набора данных, возвращаемых в зависимости от LookupType: Имя. Возвращает только имя SSN и имя прошедшего проверку подлинности пользователя. Это не имеет дополнительных затрат на поиск. NameAddress: возвращает имя, SSN и сведения об адресе. Это имеет дополнительную стоимость подстановки. Это значение по умолчанию, если значение для LookupType не задано. NameAddressFamily: возвращает имя, SSN, данные адреса, гендерный код и сведения о семье. Если выбран параметр LookupType.NameAddressFamily, в "Мета" будут возвращены дополнительные значения. Если ответ имеет ошибки или не завершен, объект клиента будет иметь значение NULL, а StatusMessage будет иметь подробное сообщение.
Создает новые последовательные (массовые) процессы подписывания	Создает новый последовательный процесс подписывания (массовый) с одним или несколькими процессами подписывания. Каждый процесс подписывания в последовательности имеет один или несколько подписок. Пример: Компания хочет подписать документ A и B. Signee X должен подписать документ A и B, Signee Y должен подписать документ A и Signee Z должен подписать Документ B. Затем новый объект CreateSequentalSigning с массивом двух объектов CreateSigningProcess. Подписи X и Y добавляются как подписи для CreateSigningProcess для Document A и подписывают X и Z добавляются в качестве подписей для Document B. Подробные сведения см. в этой документации
Создает новый процесс подписывания с одним или несколькими подписями	Создает новый процесс подписывания с одним или несколькими подписыванием.

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Дата начала поиска журнала должна быть меньшей датой, чем EndDate.	StartDate	True	date-time	Дата начала поиска журнала должна быть меньшей датой, чем EndDate.
Дата окончания поиска журнала должна быть больше даты, чем StartDate.	EndDate	True	date-time	Дата окончания поиска журнала должна быть больше даты, чем StartDate.
Используется для страницы результирующий набор и возвращает только N много результатов.	Take		integer	Используется для страницы результирующий набор и возвращает только N много результатов.
Используется для страницы результирующий набор и пропускает первые результаты N.	Skip		integer	Используется для страницы результирующий набор и пропускает первые результаты N.
Сообщение электронной почты пользователя.	User		string	Сообщение электронной почты пользователя.
Можно использовать только для получения действия для определенного типа потока.	FlowType		string	Можно использовать только для получения действия для определенного типа потока.
Если он имеет значение, мы возвращаем только записи, соответствующие этому flowKey.	FlowKey		string	Если он имеет значение, мы возвращаем только записи, соответствующие этому flowKey.

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

Список<SigningProcessActivityLogWrapper>: array of SigningProcessActivityLogWrapper

Возвращает журнал действий для пользователя (электронной почты) за определенный период

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

Возвращает журнал действий для пользователя в течение периода.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Сообщение электронной почты пользователя.	User		string	Сообщение электронной почты пользователя.
Дата начала поиска журнала должна быть меньшей датой, чем EndDate.	StartDate	True	date-time	Дата начала поиска журнала должна быть меньшей датой, чем EndDate.
Дата окончания поиска журнала должна быть больше даты, чем StartDate.	EndDate	True	date-time	Дата окончания поиска журнала должна быть больше даты, чем StartDate.
Используйте, если фильтровать по одному процессу подписывания.	ProcessKey		string	Используйте, если фильтровать по одному процессу подписывания.
Можно использовать только для получения действия для определенного типа потока.	FlowType		string	Можно использовать только для получения действия для определенного типа потока.
Используется для страницы результирующий набор и возвращает только N много результатов.	Take		integer	Используется для страницы результирующий набор и возвращает только N много результатов.
Используется для страницы результирующий набор и пропускает первые результаты N.	Skip		integer	Используется для страницы результирующий набор и пропускает первые результаты N.
Если он имеет значение, мы возвращаем только записи, которые соответствуют этому flowKey	FlowKey		string	Если он имеет значение, мы возвращаем только записи, соответствующие этому flowKey.

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

Список<SigningProcessActivityLogWrapper>: array of SigningProcessActivityLogWrapper

Возвращает журнал действий для процесса подписывания

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

Получите журнал действий для процесса подписывания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Сообщение электронной почты пользователя.	User		string	Сообщение электронной почты пользователя.
Дата начала поиска журнала должна быть меньшей датой, чем EndDate.	StartDate	True	date-time	Дата начала поиска журнала должна быть меньшей датой, чем EndDate.
Дата окончания поиска журнала должна быть больше даты, чем StartDate.	EndDate	True	date-time	Дата окончания поиска журнала должна быть больше даты, чем StartDate.
Используйте, если фильтровать по одному процессу подписывания.	ProcessKey	True	string	Используйте, если фильтровать по одному процессу подписывания.
Можно использовать только для получения действия для определенного типа потока.	FlowType		string	Можно использовать только для получения действия для определенного типа потока.
используется для страницы результирующий набор и возвращает только N много результатов.	Take		integer	используется для страницы результирующий набор и возвращает только N много результатов.
используется для страницы результирующий набор и пропускает первые результаты N.	Skip		integer	используется для страницы результирующий набор и пропускает первые результаты N.
Если он имеет значение, мы возвращаем только записи, соответствующие этому flowKey.	FlowKey		string	Если он имеет значение, мы возвращаем только записи, соответствующие этому flowKey.

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

Список<SigningProcessActivityLogWrapper>: array of SigningProcessActivityLogWrapper

Возвращает процесс подписывания по processKey и signeeKey

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

Получите процесс подписывания по ключу процесса и signeeKey.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор для одного процесса подписывания документа.	ProcessKey	True	string	Уникальный идентификатор для одного процесса подписывания документа.
Уникальный идентификатор пользователя, подписывшего единый процесс подписывания.	SigneeKey	True	string	Уникальный идентификатор пользователя, подписывшего единый процесс подписывания.
Агент пользователя — это программное обеспечение, действующее для пользователя, например веб-браузера или клиента электронной почты.	UserAgent		string	Агент пользователя — это программное обеспечение, действующее для пользователя, например веб-браузера или клиента электронной почты.

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

Подписывание

Подписывание: SigningProcess

Запечатывает PDF-документ

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

Запечатывает предоставленный PDF-документ, предоставленный в виде строки base64.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
PDFDocument	pdfDocument	True	string	Объект Base64String документа PDF для запечатывания.
flowKey	flowKey	True	string	Уникальный идентификатор потока, который принадлежит компании.
причина	reason		string	задайте причину отображения в печати
languageType	languageType		string

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

SealingResponse

SealingResponse: SealingResponse

Запечатывает XML-документ

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

Запечатывает предоставленный XML-документ, предоставленный в виде строки base64.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
xmlDocument	xmlDocument	True	string	Base64String XML-документа для запечатывания
flowKey	flowKey	True	string	Допустимый flowKey, предоставляемый Taktikal, который можно использовать для запечатывания

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

Object

response: object

Запускает процесс проверки подлинности с использованием идентификатора e-id исландии для последовательной подписи

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

Аутентификация с помощью исландийского e-id может выполняться с помощью мобильного телефона или приложения Audkenni.

Используя мобильный телефон: для параметра AuthenticationContextType должно быть задано значение "Sim", а номер телефона должен иметь номер мобильного телефона Ucelandic. Ssn игнорируется.
Использование приложения Audkenni: Для параметра AuthenticationContextType должно быть задано значение App, а номер ssn должен иметь номер социального страхования Icdlandic. Номер телефона игнорируется.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор для процессов подписывания последовательности (bulk).	SequenceKey	True	string	Уникальный идентификатор для процессов подписывания последовательности (bulk).
sequenceKey	sequenceKey	True	string
loginHint	loginHint	True	string
authenticationContextType	authenticationContextType	True	string

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

StartAuthResponse

StartAuthResponse: StartAuthResponse

Инициирует процесс проверки подлинности с помощью идентификатора e-id исландии

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

Используя мобильный телефон: для параметра AuthenticationContextType должно быть задано значение "Sim", а номер телефона должен иметь номер телефона в Исландии. Ssn игнорируется.
Использование приложения Audkenni: Для параметра AuthenticationContextType должно быть задано значение App, а номер ssn должен иметь номер социального страхования Icdlandic. Номер телефона игнорируется.

flowKey всегда должен быть предоставлен и аккуссибен на портале Taktikal.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ssn	ssn		string
номер телефона	phoneNumber		string
flowKey	flowKey	True	string	Уникальный идентификатор потока, который принадлежит компании.
authenticationContextType	authenticationContextType	True	string

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

StartAuthResponse

StartAuthResponse: StartAuthResponse

Обновление signee для данного ProcessKey и SigneeKey

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

Свойства signee можно обновить на основе предоставления ProcessKey и SigneeKey.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пользователя, подписывшего единый процесс подписывания.	SigneeKey	True	string	Уникальный идентификатор пользователя, подписывшего единый процесс подписывания.
Уникальный идентификатор для одного процесса подписывания документа.	ProcessKey	True	string	Уникальный идентификатор для одного процесса подписывания документа.
электронная почта	email		string
address	address		string
postalCode	postalCode		string
city	city		string
signeeKey	signeeKey	True	string
ProcessKey	processKey	True	string
причина	reason		string
Пользователь	user		string

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

Signee

Signee: Signee

Отмена последовательного процесса подписывания

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

Отмените последовательный процесс подписи на основе заданного ключа последовательности. Пользователь (электронная почта) может быть предоставлен, который отменяет последовательный процесс.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор процесса последовательной подписи, который необходимо указать.	SequenceKey	True	string	Идентификатор процесса последовательной подписи, который необходимо указать.
Только пользователь, который начал процесс подписывания, может отменить его.	User	True	string	Только пользователь, который начал процесс подписывания, может отменить его.

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

Последовательныйsigning

Последовательныйsigning: SequentialSigning

Отмена процесса подписывания

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

Отмена процесса подписывания на основе заданного ключа процесса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор для одного процесса подписывания документа.	ProcessKey		string	Уникальный идентификатор для одного процесса подписывания документа.
Строковый объект, обычно адрес электронной почты сотрудника, имеющего доступ к порталу.	User		string	Строковый объект, обычно адрес электронной почты сотрудника, имеющего доступ к порталу.

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

Подписывание

Подписывание: SigningProcess

Проверяет состояние проверки подлинности для пользователя с помощью идентификатора исландийского e-id

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

После успешного ответа от /Auth/Start a AuthRequestId возвращается и используется для проверки завершения проверки подлинности. Если проверка подлинности завершена и выполнена успешно, объект клиента заполняется в зависимости от lookupType. Тип подстановки указывает тип информации, извлекаемой для Национального реестра Исландии.

Существует три разных набора данных, возвращаемых в зависимости от LookupType:

Имя. Возвращает только имя SSN и имя прошедшего проверку подлинности пользователя. Это не имеет дополнительных затрат на поиск.
NameAddress: возвращает имя, SSN и сведения об адресе. Это имеет дополнительную стоимость подстановки. Это значение по умолчанию, если значение для LookupType не задано.
NameAddressFamily: возвращает имя, SSN, данные адреса, гендерный код и сведения о семье.

Если выбран параметр LookupType.NameAddressFamily, в "Мета" будут возвращены дополнительные значения.

Если ответ имеет ошибки или не завершен, объект клиента будет иметь значение NULL, а StatusMessage будет иметь подробное сообщение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
authRequestId	authRequestId	True	string
flowKey	flowKey	True	string	Уникальный идентификатор потока, который принадлежит компании.
lookupType	lookupType	True	string

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

PollCustomer

PollCustomer: PollCustomer

Создает новые последовательные (массовые) процессы подписывания

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

Создает новый последовательный процесс подписывания (массовый) с одним или несколькими процессами подписывания. Каждый процесс подписывания в последовательности имеет один или несколько подписок.

Пример:

Компания хочет подписать документ A и B. Signee X должен подписать документ A и B, Signee Y должен подписать документ A и Signee Z должен подписать Документ B.
Затем новый объект CreateSequentalSigning с массивом двух объектов CreateSigningProcess. Подписи X и Y добавляются как подписи для CreateSigningProcess для Document A и подписывают X и Z добавляются в качестве подписей для Document B.

Подробные сведения см. в этой документации

Параметры

Имя	Ключ	Обязательно	Тип	Описание
PDFDocument	pdfDocument		string	представляет собой строку base64 документа для подписывания. Это не обязательно, если flowKey заботится о создании документа.
pdfFileName	pdfFileName		string	Если pdfDocument используется значение для имени файла, необходимо указать.
flowKey	flowKey	True	string	FlowKey предоставляется Taktikal. Этот ключ поможет Taktikal обработать этот запрос. Для некоторых flowKeys Taktikal будет заботиться о создании документа. Он также будет контролировать, где подписанный документ доставляется после подписания.
ProcessKey	processKey		string
имя	name		string
ssn	ssn		string
номер телефона	phoneNumber		string
электронная почта	email		string
address	address		string
postalCode	postalCode		string
city	city		string
причина	reason		string
hidePersonalCode	hidePersonalCode		boolean
communicationDeliveryType	communicationDeliveryType		string
customSmsText	customSmsText		string
signatureType	signatureType		string
language	language		string
Словарь	meta		object	Строка словаря<, строка>
fileName	fileName		string
fileContent	fileContent		string
id	id		string
fileName	fileName		string
contentLength	contentLength		integer
Тип контента	contentType		string
URL-адрес	url		string
описание	description		string
ProcessKey	processKey		string
attachmentType	attachmentType		string
signeeKey	signeeKey		string
требуетсяAuth	requiresAuth		boolean	По умолчанию используется значение false. Если задано значение true, то всем подписателям необходимо использовать идентификатор e-Id для проверки подлинности, прежде чем просматривать документ.
signInOrder	signInOrder		boolean	По умолчанию используется значение false. Будет контролировать порядок подписывателей. Он отправляет только запрос подписи первому лицу в списке подписчиков, с которого начинается. После того, как он подписал следующего знака и т. д.
signatureLocation	signatureLocation		string	Может быть BottomLastPage или значение topFirstPage по умолчанию. Будет контролировать место отображения подписи в документе.
Пользователь	user		string	адрес электронной почты пользователя, отправляющего запрос. Может быть пустым.
sequenceKey	sequenceKey		string
activityDisplayName	activityDisplayName		string
flattenDocument	flattenDocument		boolean	По умолчанию используется значение false. Если задано значение true, мы попытаемся сравить поля ввода документов.
reminderRule	reminderRule		string	Отправляет напоминания, оставьте пустым. формат должен быть "firstReminder после x дней:Затем каждые y дни", например "1:3" будет отправлять одно напоминание через 1 день, а затем каждые три дня после этого. Оставьте пустые или пустые значения без напоминаний, допустимые значения будут отправляться в период от 0 до 30 дней (0 означает, что нет напоминаний), а затем отправлять каждые 0–15 дней (опять же, 0, то есть нет напоминаний, поэтому 0:10 будет отправлять напоминания только каждые 10 дней, а 12:0 будет отправлять только одно напоминание через 12 дней
Пользователь	user	True	string	Пользователь, который запускает последовательный процесс подписи
требуетсяAuth	requiresAuth		boolean	По умолчанию используется значение false. Если задано значение true, то всем подписателям необходимо использовать идентификатор e-Id для проверки подлинности, прежде чем просматривать документ.
signInOrder	signInOrder		boolean	По умолчанию используется значение false. Будет контролировать порядок подписывателей. Он отправляет только запрос подписи первому лицу в списке подписчиков, с которого начинается. После того, как он подписал следующего знака и т. д.

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

Последовательныйsigning

Последовательныйsigning: SequentialSigning

Создает новый процесс подписывания с одним или несколькими подписями

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

Создает новый процесс подписывания с одним или несколькими подписыванием.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
PDFDocument	pdfDocument		string	представляет собой строку base64 документа для подписывания. Это не обязательно, если flowKey заботится о создании документа.
pdfFileName	pdfFileName		string	Если pdfDocument используется значение для имени файла, необходимо указать.
flowKey	flowKey	True	string	FlowKey предоставляется Taktikal. Этот ключ поможет Taktikal обработать этот запрос. Для некоторых flowKeys Taktikal будет заботиться о создании документа. Он также будет контролировать, где подписанный документ доставляется после подписания.
ProcessKey	processKey		string
имя	name		string
ssn	ssn		string
номер телефона	phoneNumber		string
электронная почта	email		string
address	address		string
postalCode	postalCode		string
city	city		string
причина	reason		string
hidePersonalCode	hidePersonalCode		boolean
communicationDeliveryType	communicationDeliveryType		string
customSmsText	customSmsText		string
signatureType	signatureType		string
language	language		string
Словарь	meta		object	Строка словаря<, строка>
fileName	fileName		string
fileContent	fileContent		string
id	id		string
fileName	fileName		string
contentLength	contentLength		integer
Тип контента	contentType		string
URL-адрес	url		string
описание	description		string
ProcessKey	processKey		string
attachmentType	attachmentType		string
signeeKey	signeeKey		string
требуетсяAuth	requiresAuth		boolean	По умолчанию используется значение false. Если задано значение true, то всем подписателям необходимо использовать идентификатор e-Id для проверки подлинности, прежде чем просматривать документ.
signInOrder	signInOrder		boolean	По умолчанию используется значение false. Будет контролировать порядок подписывателей. Он отправляет только запрос подписи первому лицу в списке подписчиков, с которого начинается. После того, как он подписал следующего знака и т. д.
signatureLocation	signatureLocation		string	Может быть BottomLastPage или значение topFirstPage по умолчанию. Будет контролировать место отображения подписи в документе.
Пользователь	user		string	адрес электронной почты пользователя, отправляющего запрос. Может быть пустым.
sequenceKey	sequenceKey		string
activityDisplayName	activityDisplayName		string
flattenDocument	flattenDocument		boolean	По умолчанию используется значение false. Если задано значение true, мы попытаемся сравить поля ввода документов.
reminderRule	reminderRule		string	Отправляет напоминания, оставьте пустым. формат должен быть "firstReminder после x дней:Затем каждые y дни", например "1:3" будет отправлять одно напоминание через 1 день, а затем каждые три дня после этого. Оставьте пустые или пустые значения без напоминаний, допустимые значения будут отправляться в период от 0 до 30 дней (0 означает, что нет напоминаний), а затем отправлять каждые 0–15 дней (опять же, 0, то есть нет напоминаний, поэтому 0:10 будет отправлять напоминания только каждые 10 дней, а 12:0 будет отправлять только одно напоминание через 12 дней

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

Подписывание

Подписывание: SigningProcess

Определения

Signee

Имя	Путь	Тип
имя	name	string
ssn	ssn	string
номер телефона	phoneNumber	string
электронная почта	email	string
address	address	string
postalCode	postalCode	string
city	city	string
key	key	string
подписанный	signed	boolean
signedAt	signedAt	date-time
ProcessKey	processKey	string
причина	reason	string
hidePersonalCode	hidePersonalCode	boolean
communicationDeliveryType	communicationDeliveryType	string
URL-адрес	url	string
signatureType	signatureType	string
language	language	string
customSmsText	customSmsText	string

ПодписываниеAttachment

Имя	Путь	Тип	Описание
fileName	fileName	string
fileContent	fileContent	string

AttachmentReference

Имя	Путь	Тип
id	id	string
fileName	fileName	string
contentLength	contentLength	integer
Тип контента	contentType	string
URL-адрес	url	string
описание	description	string
ProcessKey	processKey	string
attachmentType	attachmentType	string
signeeKey	signeeKey	string

Dictionary_String_String_

Строка словаря<, строка>

Имя	Путь	Тип	Описание
Словарь		object	Строка словаря<, строка>

ПодписьProcessActivityLogWrapper

Имя	Путь	Тип
ProcessKey	processKey	string
activityLog	activityLog	array of SigningProcessActivityLog
подписи	signees	array of SigneeActivityLog
sequenceSignees	sequenceSignees	array of SequentialSigningSigneeActivityLog
attachmentReferences	attachmentReferences	array of AttachmentReference
activityDisplayName	activityDisplayName	string

ПодписываниеProcessActivityLog

Имя	Путь	Тип	Описание
flowKey	flowKey	string	Уникальный идентификатор потока, который принадлежит компании.
ProcessKey	processKey	string
signeeKey	signeeKey	string
статус	status	string
описание	description	string
userAgent	userAgent	string
fileName	fileName	string
createdAt	createdAt	date-time
создано кем	createdBy	string
требуетсяAuth	requiresAuth	boolean
signInOrder	signInOrder	boolean
signatureLocation	signatureLocation	string
sequenceKey	sequenceKey	string

SigneeActivityLog

Имя	Путь	Тип
ProcessKey	processKey	string
signeeKey	signeeKey	string
ssn	ssn	string
имя	name	string
address	address	string
postalCode	postalCode	string
city	city	string
phone	phone	string
электронная почта	email	string
createdAt	createdAt	date-time
создано кем	createdBy	string
обновлено	updatedAt	date-time
signatureType	signatureType	string

ПоследовательныйsigningSigningSigneeActivityLog

Имя	Путь	Тип
sequenceKey	sequenceKey	string
signeeKey	signeeKey	string
URL-адрес	url	string
подписывание ключей	signingKeys	array of SigneeKeys

SigneeKeys

Имя	Путь	Тип	Описание
signeeKey	signeeKey	string
ProcessKey	processKey	string

Последовательныйsigning

Имя	Путь	Тип
key	key	string
статус	status	string
требуетсяAuth	requiresAuth	boolean
Пользователь	user	string
signInOrder	signInOrder	boolean
подписи	signees	array of SequentialSigningSignee
подписываниеProcesses	signingProcesses	array of SigningProcess

SequentialSigningSignee

Имя	Путь	Тип
key	key	string
URL-адрес	url	string
подписывание ключей	signingKeys	array of SigneeKeys

Подписывание

Имя	Путь	Тип	Описание
key	key	string
подписи	signees	array of Signee
flowKey	flowKey	string	Уникальный идентификатор потока, который принадлежит компании.
статус	status	string
Словарь	meta	Dictionary_String_String_	Строка словаря<, строка>
pdfFileName	pdfFileName	string
attachments	attachments	array of SigningAttachment
attachmentReferences	attachmentReferences	array of AttachmentReference
требуетсяAuth	requiresAuth	boolean
Пользователь	user	string
signInOrder	signInOrder	boolean
signatureLocation	signatureLocation	string
sequenceKey	sequenceKey	string
flattenDocument	flattenDocument	boolean

StartAuthResponse

Имя	Путь	Тип	Описание
authRequestId	authRequestId	string
код проверки	verificationCode	string

SealingResponse

Имя	Путь	Тип	Описание
PDFDocument	pdfDocument	string

Клиент

Имя	Путь	Тип	Описание
имя	name	string
ssn	ssn	string
номер телефона	phoneNumber	string
электронная почта	email	string
address	address	string
postalCode	postalCode	string
city	city	string
token	token	string
flowKey	flowKey	string	Уникальный идентификатор потока, который принадлежит компании.
Словарь	meta	Dictionary_String_String_	Строка словаря<, строка>

PollCustomer

Имя	Путь	Тип	Описание
Клиент	customer	Customer	Клиент
statusMessage	statusMessage	string
waitForUserInput	waitingForUserInput	boolean

объект

Это тип object.