Знак Zoho

Подпись Zoho — это полное приложение цифровой подписи, которое помогает цифрово подписывать бизнес-документы с полной безопасностью и надежностью.

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

Услуга 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)
Контакт
Имя Поддержка API подписи Zoho
URL https://www.zoho.com/sign/contact.html
Адрес электронной почты support@zohosign.com
Метаданные соединителя
Publisher Zoho Corporation
Веб-сайт https://www.zoho.com/sign/
Политика конфиденциальности https://www.zoho.com/privacy.html
Категории Содержимое и файлы; Продуктивность

Цифровая подпись бизнес-документов в Интернете с полным безопасностью и надежностью с помощью программного обеспечения электронной подписи Zoho. Автоматизация транзакций с помощью простых рабочих процессов документа электронной подписи. Полное приложение цифровой подписи для деловых подписей.

Предпосылки

Чтобы использовать этот соединитель, необходимо заплатить за учетную запись Zoho-Sign на платформе Zoho-Sign. Дополнительные сведения см. в статье https://www.zoho.com/sign/pricing-api.html "Вы также можете настроить учетную запись здесь https://zoho.com/sign ##How, чтобы получить учетные данные API Zoho-Sign использует OAuth 2 для проверки подлинности. Поэтому после настройки учетной записи дополнительные шаги не требуются.

Для всех API-интерфейсов подписи Zoho требуется этот обязательный заголовок: авторизация — заголовок запроса проверки подлинности.

Сведения о поколениях токенов см. в следующих статье: https://www.zoho.com/sign/api/#getting-started

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

Zoho Sign Connector предоставляет пользователям возможность выполнять управление документами, управление шаблонами и другие операции напрямую без доступа к веб-интерфейсу Zoho Sign

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

Аналогичным образом для других операций см. заголовок "ЧТО ТАКОЕ ПОДДЕРЖИВАЕМЫЕ ОПЕРАЦИИ?" в приведенной ниже ссылке.

https://www.zoho.com/sign/api/#introduction

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

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

В случае ошибки выполните отладку с соответствующими кодами ошибок и их причиной.

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

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
Выберите регион. струна Выберите домен. True

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

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

Действия

SendSignRequest

Отправка отправленного документа для подписи

Вызов API

Вызов API

Напоминание для получателей

Отправьте напоминание получателям определенного документа.

Обновление свойств созданного запроса

Обновление свойств созданного запроса

Отзыв определенного документа

Отзыв определенного документа

Получение данных завершенного запроса

Отображение сведений о подписанном конверте

Получение документа

Отображение сведений о конкретном конверте

Получение сведений о конкретном шаблоне

Отображение сведений о конкретном шаблоне документа

Получение списка шаблонов

Отображает список всех созданных шаблонов документов

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

Скачивает определенный конверт

Скачивание сертификата завершения

Скачивает сертификат завершения определенного конверта

Скачивание файла

Скачивает определенный документ или файл

Создание документа для подписывания

Действие для создания документа для подписывания путем отправки файла.

Удаление документа

Удаление определенного документа

SendSignRequest

Отправка отправленного документа для подписи

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
RequestId True string

Идентификатор запроса

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

Имя Путь Тип Описание
код
code integer

код

сообщение
message string

сообщение

статус
status string

статус

Вызов API

Вызов API

Параметры

Имя Ключ Обязательно Тип Описание
путь URL
url True string

Укажите путь url-адреса

Метод
method True string

Выбор метода API для использования

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

response
object

Напоминание для получателей

Отправьте напоминание получателям определенного документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

Обновление свойств созданного запроса

Обновление свойств созданного запроса

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
RequestId True string

Идентификатор запроса

Тип документа
request_type_id string

request_type_id

Имя документа
request_name True string

Имя документа (запрос)

Имя получателя
recipient_name string

Имя получателя

Электронная почта получателя
recipient_email string

Электронная почта получателя

Номер телефона
recipient_phonenumber string

Номер телефона получателя для режима проверки подлинности SMS.

Код страны
recipient_countrycode string

Код страны номера телефона получателя для режима проверки подлинности SMS.

ТипДействия
action_type string

Выберите, является ли получатель подписыватель или средство просмотра, утверждающий или неперссонSigner.

Частные заметки
private_notes string

Частные заметки

Порядок подписывания
signing_order integer

Порядок подписывания

Требуется проверка подлинности для получателя
verify_recipient boolean

Должен ли получатель проверяться одним из режимов проверки подлинности.

Тип доставки проверки подлинности
verification_type string

Тип проверки

Код проверки
verification_code string

6 цифр кода проверки для режима ПРОВЕРКИ В АВТОНОМНОМ режиме.

Дни до завершения
expiration_days integer

Количество дней, оставшихся для документа, истекло.

Отправка по порядку
is_sequential boolean

Разрешить получателям входить в указанный порядок.

Автоматические напоминания
email_reminders boolean

Включите периодические напоминания для получателей для подписывания документа.

Отправка оставшихся элементов каждые (дни)
reminder_period integer

Укажите интервал времени, в котором должно быть отправлено напоминание о подписании получателям.

Folder
folder_id string

уникальный идентификатор папки

Примечания.
notes html

Примечания для всех получателей.

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

Имя Путь Тип Описание
код
code integer

код

сообщение
message string

сообщение

статус
status string

статус

Отзыв определенного документа

Отзыв определенного документа

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

Получение данных завершенного запроса

Отображение сведений о подписанном конверте

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

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

Имя Путь Тип Описание
код
code integer

код

request_name
document_form_data.request_name string

Имя запроса

zsdocumentid
document_form_data.zsdocumentid string

Zoho Sign Documentid

Действия
document_form_data.actions array of object

Действия

signed_time
document_form_data.actions.signed_time string

Время подписи

action_type
document_form_data.actions.action_type string

Тип действия

recipient_email
document_form_data.actions.recipient_email string

Электронная почта получателя

recipient_name
document_form_data.actions.recipient_name string

Имя получателя

столбцов
document_form_data.actions.fields array of object

столбцов

field_label
document_form_data.actions.fields.field_label string

Метка поля

field_value
document_form_data.actions.fields.field_value string

Значение поля

field_name
document_form_data.actions.fields.field_name string

Имя поля

статус
status string

статус

Получение документа

Отображение сведений о конкретном конверте

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
RequestId True integer

Идентификатор запроса

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

Имя Путь Тип Описание
код
code integer

код

request_status
requests.request_status string

Состояние запроса

заметки
requests.notes string

Примечания.

attachments
requests.attachments array of

Attachments

reminder_period
requests.reminder_period integer

Период напоминания

owner_id
requests.owner_id string

Идентификатор ответственного

описание
requests.description string

Описание запроса

request_name
requests.request_name string

Имя запроса

modified_time
requests.modified_time integer

Измененное время

action_time
requests.action_time integer

Время действия

is_deleted
requests.is_deleted boolean

Удаление состояния запроса

expiration_days
requests.expiration_days integer

Срок действия дней

is_sequential
requests.is_sequential boolean

Последовательное состояние

sign_submitted_time
requests.sign_submitted_time integer

Время отправки подписи

owner_first_name
requests.owner_first_name string

Имя владельца

sign_percentage
requests.sign_percentage float

Процент подписи

expire_by
requests.expire_by integer

Дата окончания срока действия документа

is_expiring
requests.is_expiring boolean

Срок действия документа истекает

owner_email
requests.owner_email string

Идентификатор электронной почты владельца

created_time
requests.created_time integer

Время создания документа

email_reminders
requests.email_reminders boolean

Отправка напоминаний по электронной почте

document_ids
requests.document_ids array of object

Идентификаторы документов

image_string
requests.document_ids.image_string string

Строка изображения

document_name
requests.document_ids.document_name string

Имя документа

pages
requests.document_ids.pages array of object

pages

image_string
requests.document_ids.pages.image_string string

Строка изображения

page
requests.document_ids.pages.page integer

page

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

Состояние эскиза

document_size
requests.document_ids.document_size integer

Размер документа

document_order
requests.document_ids.document_order string

Порядок документов

total_pages
requests.document_ids.total_pages integer

Всего страниц no.of в документе

document_id
requests.document_ids.document_id string

Идентификатор документа

self_sign
requests.self_sign boolean

Состояние самозаверяемого знака

sign_id
requests.sign_id string

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

folder_name
requests.folder_name string

Имя папки

in_process
requests.in_process boolean

Состояние процесса

обоснованность
requests.validity integer

Допустимость документа

request_type_name
requests.request_type_name string

Имя типа запроса

folder_id
requests.folder_id string

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

идентификатор запроса
requests.request_id string

Идентификатор запроса

request_type_id
requests.request_type_id string

Идентификатор типа запроса

owner_last_name
requests.owner_last_name string

Фамилия владельца

Действия
requests.actions array of object

Действия

verify_recipient
requests.actions.verify_recipient boolean

Проверка идентификатора почты получателей

action_type
requests.actions.action_type string

Тип действия

private_notes
requests.actions.private_notes string

Частные заметки

recipient_email
requests.actions.recipient_email string

Идентификатор электронной почты получателя

send_completed_document
requests.actions.send_completed_document boolean

Состояние завершенного документа отправки

verification_type
requests.actions.verification_type string

Тип проверки

allow_signing
requests.actions.allow_signing boolean

Разрешить состояние подписывания

recipient_phonenumber
requests.actions.recipient_phonenumber string

Номер телефона получателя

is_bulk
requests.actions.is_bulk boolean

Состояние массового

action_id
requests.actions.action_id string

Идентификатор действия

is_revoked
requests.actions.is_revoked boolean

Состояние отзыва

is_embedded
requests.actions.is_embedded boolean

Состояние внедренного

signing_order
requests.actions.signing_order integer

Порядок подписывания

recipient_name
requests.actions.recipient_name string

Имя получателя

action_status
requests.actions.action_status string

Состояние действия

recipient_countrycode
requests.actions.recipient_countrycode string

Код страны получателя

ishost
requests.actions.ishost boolean

Состояние использования узла

language
requests.actions.language string

language

in_person_name
requests.actions.in_person_name string

Имя пользователя

in_person_email
requests.actions.in_person_email string

Личное сообщение электронной почты

verification_code
requests.actions.verification_code string

Код проверки

attachment_size
requests.attachment_size integer

Размер вложения

сообщение
message string

сообщение

статус
status string

статус

Получение сведений о конкретном шаблоне

Отображение сведений о конкретном шаблоне документа

Параметры

Имя Ключ Обязательно Тип Описание
Список шаблонов
template_id True string

Список шаблонов

Получение списка шаблонов

Отображает список всех созданных шаблонов документов

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

Имя Путь Тип Описание
templates
templates array of object
идентификатор_шаблона
templates.template_id string
template_name
templates.template_name string

Имя шаблона

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

Скачивает определенный конверт

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

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

response
file

Скачивание сертификата завершения

Скачивает сертификат завершения определенного конверта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

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

response
file

Скачивание файла

Скачивает определенный документ или файл

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

Идентификатор документа
document_id True integer

Идентификатор документа

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

response
file

Создание документа для подписывания

Действие для создания документа для подписывания путем отправки файла.

Параметры

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

создание документа

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

Имя Путь Тип Описание
код
code integer

код

request_status
requests.request_status string

Состояние запроса

owner_email
requests.owner_email string

Электронная почта владельца

created_time
requests.created_time integer

Время создания

document_ids
requests.document_ids array of object

document_ids

image_string
requests.document_ids.image_string string

Строка изображения

document_name
requests.document_ids.document_name string

Имя документа

pages
requests.document_ids.pages array of object

pages

image_string
requests.document_ids.pages.image_string string

Строка изображения

page
requests.document_ids.pages.page integer

page

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

is_thumbnail

document_size
requests.document_ids.document_size integer

Размер документа

document_order
requests.document_ids.document_order string

Порядок документов

total_pages
requests.document_ids.total_pages integer

Всего страниц

document_id
requests.document_ids.document_id string

Идентификатор документа

заметки
requests.notes string

заметки

self_sign
requests.self_sign boolean

самозаверяет

owner_id
requests.owner_id string

идентификатор владельца

описание
requests.description string

Description

folder_name
requests.folder_name string

Имя папки

request_name
requests.request_name string

Имя запроса

modified_time
requests.modified_time integer

измененное время

is_deleted
requests.is_deleted boolean

Состояние удаления

expiration_days
requests.expiration_days integer

Срок действия дней

in_process
requests.in_process boolean

В процессе

is_sequential
requests.is_sequential boolean

Последовательное состояние

request_type_name
requests.request_type_name string

Имя типа запроса

owner_first_name
requests.owner_first_name string

Имя владельца

folder_id
requests.folder_id string

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

идентификатор запроса
requests.request_id string

Идентификатор запроса

request_type_id
requests.request_type_id string

Идентификатор типа запроса

owner_last_name
requests.owner_last_name string

Фамилия владельца

sign_percentage
requests.sign_percentage integer

Процент подписи

сообщение
message string

Message

статус
status string

статус

Удаление документа

Удаление определенного документа

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор запроса
request_id True integer

Идентификатор запроса

Триггеры

Триггеры подписи Zoho

Регистрация обратного вызова для определенного события

Триггеры подписи Zoho

Регистрация обратного вызова для определенного события

Параметры

Имя Ключ Обязательно Тип Описание
Действия
webhook_actions True string

Действия веб-перехватчика

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

Имя Путь Тип Описание
request_status
requests.request_status string

Состояние запроса

заметки
requests.notes string

заметки

reminder_period
requests.reminder_period integer

период напоминания

owner_id
requests.owner_id string

идентификатор владельца

описание
requests.description string

описание

request_name
requests.request_name string

Имя запроса

modified_time
requests.modified_time integer

Измененное время

action_time
requests.action_time integer

Время действия

is_deleted
requests.is_deleted boolean

Состояние удаленного

expiration_days
requests.expiration_days integer

Срок действия дней

is_sequential
requests.is_sequential boolean

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

sign_submitted_time
requests.sign_submitted_time integer

Время отправки подписи

owner_first_name
requests.owner_first_name string

Владелец первого имени

sign_percentage
requests.sign_percentage integer

Процент подписи

expire_by
requests.expire_by integer

Срок действия истекает по

owner_email
requests.owner_email string

Электронная почта владельца

created_time
requests.created_time integer

Время создания

email_reminders
requests.email_reminders boolean

Напоминания по электронной почте

document_ids
requests.document_ids array of object

Список идентификаторов документов

document_name
requests.document_ids.document_name string

Введите имя документа

document_size
requests.document_ids.document_size integer

Размер документа

document_order
requests.document_ids.document_order string

Порядок документа

total_pages
requests.document_ids.total_pages integer

Общее количество страниц в документе

document_id
requests.document_ids.document_id string

Идентификатор документа

self_sign
requests.self_sign boolean

Состояние самозаверяющего знака

in_process
requests.in_process boolean

Состояние процесса

обоснованность
requests.validity integer

Обоснованность

request_type_name
requests.request_type_name string

Имя типа запроса

decline_reason
requests.decline_reason string

Причина отклонения

идентификатор запроса
requests.request_id string

Идентификатор запроса

request_type_id
requests.request_type_id string

Идентификатор типа запроса

owner_last_name
requests.owner_last_name string

Фамилия владельца

Действия
requests.actions array of object

Действия

verify_recipient
requests.actions.verify_recipient boolean

Проверка получателя

action_type
requests.actions.action_type string

Тип действия

private_notes
requests.actions.private_notes string

Частные заметки

recipient_email
requests.actions.recipient_email string

Электронная почта получателя

allow_signing
requests.actions.allow_signing boolean

Состояние подписывания

recipient_phonenumber
requests.actions.recipient_phonenumber string

Номер телефона получателя

is_bulk
requests.actions.is_bulk boolean

Состояние массового действия

action_id
requests.actions.action_id string

Идентификатор действия

is_revoked
requests.actions.is_revoked boolean

Состояние отзыва

is_embedded
requests.actions.is_embedded boolean

Состояние внедренного

signing_order
requests.actions.signing_order integer

Порядок подписывания

recipient_name
requests.actions.recipient_name string

Имя получателя

action_status
requests.actions.action_status string

Состояние действия

recipient_countrycode
requests.actions.recipient_countrycode string

Код страны получателя

performed_by_email
notifications.performed_by_email string

Выполняется по электронной почте

performed_at
notifications.performed_at integer

Выполнено в

причина
notifications.reason string

Причина

активность
notifications.activity string

Activity

operation_type
notifications.operation_type string

Тип операции

action_id
notifications.action_id string

Идентификатор действия

performed_by_name
notifications.performed_by_name string

Выполняется по имени

signing_order
notifications.signing_order integer

Порядок подписывания

ip_address
notifications.ip_address string

Ip-адрес

Определения

file

Это базовый тип данных file.

объект

Это тип object.