Compartilhar via


Signo do Zoho

O Zoho's Sign é um aplicativo de assinatura digital completo que ajuda a assinar digitalmente documentos comerciais com total segurança e confiabilidade

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte à API de Assinatura do Zoho
URL https://www.zoho.com/sign/contact.html
Email support@zohosign.com
Metadados do conector
Publicador Zoho Corporation
Site https://www.zoho.com/sign/
Política de privacidade https://www.zoho.com/privacy.html
Categorias Conteúdo e arquivos; Produtividade

Assine digitalmente documentos comerciais online com segurança e confiabilidade completas usando o software de assinatura eletrônico do Zoho. Automatize suas transações com fluxos de trabalho de documento de sinal eletrônico simples. Um aplicativo de assinatura digital completo para signatários de negócios.

Pré-requisitos

Para usar esse conector, você deve ter pago por Zoho-Sign conta na plataforma Zoho-Sign. Para obter detalhes, consulte https://www.zoho.com/sign/pricing-api.html Você também pode configurar uma conta aqui https://zoho.com/sign ##How para obter credenciais A API Zoho-Sign usa o OAuth 2 para autenticar. Portanto, depois que a conta for configurada, nenhuma etapa adicional será necessária.

Todas as APIs de Signo do Zoho exigem esse cabeçalho obrigatório: Autorização – cabeçalho de solicitação de autenticação.

Para gerações de token, consulte: https://www.zoho.com/sign/api/#getting-started

Introdução ao conector

O Zoho Sign Connector fornece a opção para os usuários executarem o gerenciamento de documentos, o gerenciamento de modelos e outras operações diretamente, sem acessar a interface da Web do Zoho Sign

No gerenciador de documentos, usando esses conectores, os usuários podem criar documentos, atualizar documentos, enviar documentos para assinaturas e obter uma lista de todos os documentos relacionados à sua conta.

Da mesma forma para outras operações, consulte o título "QUAIS SÃO AS OPERAÇÕES COM SUPORTE?" no link abaixo,

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

Esses conectores ajudarão você a automatizar o uso, diretamente do documento ou do modelo que envia para o controle de status e muito mais.

Erros e soluções comuns

No caso de um erro, depure-o com os códigos de erro adequados e seu motivo.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Selecione a região. cadeia Selecione o domínio. Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar as propriedades de uma solicitação criada

Atualizar as propriedades de uma solicitação criada

Baixar Arquivo

Baixa um documento ou arquivo específico

Baixar certificado de conclusão

Baixa o certificado de conclusão de um envelope específico

Baixar Documento

Baixa um envelope específico

Criar um documento para assinatura

Uma ação para criar um documento para assinatura carregando um arquivo.

Excluir Documento

Excluir um documento específico

Invocar a API

Invocar a API

Lembre-se de um documento específico

Lembre-se de um documento específico

Lembrete para destinatários

Envie um lembrete aos destinatários de um documento específico.

Obter dados da solicitação concluída

Mostra os detalhes de um envelope assinado

Obter detalhes específicos do modelo

Mostra os detalhes de um modelo de documento específico

Obter lista de modelos

Mostra uma lista de todos os modelos de documento criados

Obter um documento

Mostra os detalhes de um envelope específico

SendSignRequest

Enviar o documento carregado para assinatura

Atualizar as propriedades de uma solicitação criada

Atualizar as propriedades de uma solicitação criada

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
RequestId True string

ID da Solicitação

Tipo de documento
request_type_id string

request_type_id

Nome do documento
request_name True string

Nome do documento (solicitação)

Nome do destinatário
recipient_name string

Nome do destinatário

Email do destinatário
recipient_email string

Email do destinatário

Número de Telefone
recipient_phonenumber string

Número de telefone do destinatário para o modo sms de autenticação.

Código do país
recipient_countrycode string

Código do país do número de telefone do destinatário para o modo sms de autenticação.

Tipo de Ação
action_type string

Selecione se o destinatário é um Signatário ou um visualizador ou um aprovador ou um inpersonSigner.

Notas privadas
private_notes string

Notas privadas

Ordem de Assinatura
signing_order integer

Ordem de assinatura

Precisa de autenticação para destinatário
verify_recipient boolean

Se o destinatário precisa ser verificado por um dos modos de autenticação.

Tipo de entrega de autenticação
verification_type string

Tipo de verificação

Código de verificação
verification_code string

Código de verificação de 6 dígitos para o modo de verificação OFFLINE.

Dias para concluir
expiration_days integer

Número de dias restantes para o documento expirar.

Enviar em ordem
is_sequential boolean

Permitir que os destinatários entrem na ordem especificada.

Lembretes automáticos
email_reminders boolean

Habilite lembretes periódicos para os destinatários assinarem o documento.

Enviar um restante a cada - (dias)
reminder_period integer

Especifique o intervalo de tempo no qual um lembrete para assinatura deve ser enviado aos destinatários.

Pasta
folder_id string

ID exclusiva da pasta

Anotações
notes html

Anotações para todos os destinatários.

Retornos

Nome Caminho Tipo Description
codificar
code integer

codificar

mensagem
message string

mensagem

status
status string

status

Baixar Arquivo

Baixa um documento ou arquivo específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

ID do documento
document_id True integer

ID do documento

Retornos

response
file

Baixar certificado de conclusão

Baixa o certificado de conclusão de um envelope específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

Retornos

response
file

Baixar Documento

Baixa um envelope específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

Retornos

response
file

Criar um documento para assinatura

Uma ação para criar um documento para assinatura carregando um arquivo.

Parâmetros

Nome Chave Obrigatório Tipo Description
criar um documento
file True file

criar um documento

Retornos

Nome Caminho Tipo Description
codificar
code integer

codificar

request_status
requests.request_status string

Status da solicitação

owner_email
requests.owner_email string

Email do proprietário

created_time
requests.created_time integer

Tempo de criação

document_ids
requests.document_ids array of object

document_ids

image_string
requests.document_ids.image_string string

Cadeia de caracteres de imagem

document_name
requests.document_ids.document_name string

Nome do documento

Páginas
requests.document_ids.pages array of object

Páginas

image_string
requests.document_ids.pages.image_string string

Cadeia de caracteres de imagem

página
requests.document_ids.pages.page integer

página

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

is_thumbnail

document_size
requests.document_ids.document_size integer

Tamanho do documento

document_order
requests.document_ids.document_order string

Ordem do documento

total_pages
requests.document_ids.total_pages integer

Total de páginas

document_id
requests.document_ids.document_id string

ID do documento

notas
requests.notes string

notas

self_sign
requests.self_sign boolean

autoassinar

owner_id
requests.owner_id string

ID do proprietário

descrição
requests.description string

Description

folder_name
requests.folder_name string

Nome da pasta

request_name
requests.request_name string

Nome da solicitação

modified_time
requests.modified_time integer

tempo modificado

is_deleted
requests.is_deleted boolean

Status da exclusão

expiration_days
requests.expiration_days integer

Dias de expiração

in_process
requests.in_process boolean

Processando

is_sequential
requests.is_sequential boolean

Status sequencial

request_type_name
requests.request_type_name string

Nome do tipo de solicitação

owner_first_name
requests.owner_first_name string

Nome do proprietário

folder_id
requests.folder_id string

ID da pasta

request_id
requests.request_id string

ID da solicitação

request_type_id
requests.request_type_id string

ID do tipo de solicitação

owner_last_name
requests.owner_last_name string

Sobrenome do Proprietário

sign_percentage
requests.sign_percentage integer

Porcentagem de sinal

mensagem
message string

Message

status
status string

status

Excluir Documento

Excluir um documento específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

Invocar a API

Invocar a API

Parâmetros

Nome Chave Obrigatório Tipo Description
Caminho da URL
url True string

Fornecer caminho de URL

Método
method True string

Selecionar método de API a ser usado

Retornos

response
object

Lembre-se de um documento específico

Lembre-se de um documento específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

Lembrete para destinatários

Envie um lembrete aos destinatários de um documento específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da Solicitação

Obter dados da solicitação concluída

Mostra os detalhes de um envelope assinado

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
request_id True integer

ID da solicitação

Retornos

Nome Caminho Tipo Description
codificar
code integer

codificar

request_name
document_form_data.request_name string

Nome da solicitação

zsdocumentid
document_form_data.zsdocumentid string

Zoho Sign Documentid

Ações
document_form_data.actions array of object

Ações

signed_time
document_form_data.actions.signed_time string

Hora assinada

action_type
document_form_data.actions.action_type string

Tipo de ação

recipient_email
document_form_data.actions.recipient_email string

Email do destinatário

recipient_name
document_form_data.actions.recipient_name string

Nome do destinatário

fields
document_form_data.actions.fields array of object

fields

field_label
document_form_data.actions.fields.field_label string

Rótulo de campo

field_value
document_form_data.actions.fields.field_value string

Valor do campo

field_name
document_form_data.actions.fields.field_name string

Nome do campo

status
status string

status

Obter detalhes específicos do modelo

Mostra os detalhes de um modelo de documento específico

Parâmetros

Nome Chave Obrigatório Tipo Description
Lista de modelos
template_id True string

Lista de modelos

Obter lista de modelos

Mostra uma lista de todos os modelos de documento criados

Retornos

Nome Caminho Tipo Description
templates
templates array of object
template_id
templates.template_id string
template_name
templates.template_name string

Nome do modelo

Obter um documento

Mostra os detalhes de um envelope específico

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
RequestId True integer

ID da Solicitação

Retornos

Nome Caminho Tipo Description
codificar
code integer

codificar

request_status
requests.request_status string

Status da solicitação

notas
requests.notes string

Anotações

attachments
requests.attachments array of

Attachments

reminder_period
requests.reminder_period integer

Período de lembrete

owner_id
requests.owner_id string

ID do Proprietário

descrição
requests.description string

Descrição da solicitação

request_name
requests.request_name string

Nome da solicitação

modified_time
requests.modified_time integer

Tempo Modificado

action_time
requests.action_time integer

Tempo de ação

is_deleted
requests.is_deleted boolean

Excluir o status da solicitação

expiration_days
requests.expiration_days integer

Dias de expiração

is_sequential
requests.is_sequential boolean

Status sequencial

sign_submitted_time
requests.sign_submitted_time integer

Hora de envio do sinal

owner_first_name
requests.owner_first_name string

Nome do proprietário

sign_percentage
requests.sign_percentage float

Porcentagem de sinal

expire_by
requests.expire_by integer

Data de expiração do documento

is_expiring
requests.is_expiring boolean

Documento expirando em

owner_email
requests.owner_email string

ID de email do proprietário

created_time
requests.created_time integer

Hora em que o documento foi criado

email_reminders
requests.email_reminders boolean

Enviando lembretes por email

document_ids
requests.document_ids array of object

IDs de documento

image_string
requests.document_ids.image_string string

Cadeia de caracteres de imagem

document_name
requests.document_ids.document_name string

Nome do documento

Páginas
requests.document_ids.pages array of object

Páginas

image_string
requests.document_ids.pages.image_string string

Cadeia de caracteres de imagem

página
requests.document_ids.pages.page integer

página

is_thumbnail
requests.document_ids.pages.is_thumbnail boolean

Status da miniatura

document_size
requests.document_ids.document_size integer

Tamanho do documento

document_order
requests.document_ids.document_order string

Ordem do documento

total_pages
requests.document_ids.total_pages integer

Total de no.of pages no documento

document_id
requests.document_ids.document_id string

ID do documento

self_sign
requests.self_sign boolean

Status do autoassinamento

sign_id
requests.sign_id string

Assinar id

folder_name
requests.folder_name string

Nome da pasta

in_process
requests.in_process boolean

No status do processo

validade
requests.validity integer

Validade do documento

request_type_name
requests.request_type_name string

Nome do tipo de solicitação

folder_id
requests.folder_id string

ID da pasta

request_id
requests.request_id string

ID da solicitação

request_type_id
requests.request_type_id string

ID do tipo de solicitação

owner_last_name
requests.owner_last_name string

Sobrenome do proprietário

Ações
requests.actions array of object

Ações

verify_recipient
requests.actions.verify_recipient boolean

Verificar a ID do Email dos Destinatários

action_type
requests.actions.action_type string

Tipo de ação

private_notes
requests.actions.private_notes string

Notas privadas

recipient_email
requests.actions.recipient_email string

ID de email do destinatário

send_completed_document
requests.actions.send_completed_document boolean

Status do envio do documento concluído

verification_type
requests.actions.verification_type string

Tipo de verificação

allow_signing
requests.actions.allow_signing boolean

Permitir status de assinatura

recipient_phonenumber
requests.actions.recipient_phonenumber string

Número de telefone do destinatário

is_bulk
requests.actions.is_bulk boolean

Status de massa

action_id
requests.actions.action_id string

ID da ação

is_revoked
requests.actions.is_revoked boolean

Status da revogação

is_embedded
requests.actions.is_embedded boolean

Status da inserção

signing_order
requests.actions.signing_order integer

Ordem de assinatura

recipient_name
requests.actions.recipient_name string

Nome do destinatário

action_status
requests.actions.action_status string

Status da ação

recipient_countrycode
requests.actions.recipient_countrycode string

Código de país do destinatário

ishost
requests.actions.ishost boolean

status de uso do host

linguagem
requests.actions.language string

linguagem

in_person_name
requests.actions.in_person_name string

Nome da pessoa

in_person_email
requests.actions.in_person_email string

Email pessoal

verification_code
requests.actions.verification_code string

Código de verificação

attachment_size
requests.attachment_size integer

Tamanho do anexo

mensagem
message string

mensagem

status
status string

status

SendSignRequest

Enviar o documento carregado para assinatura

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Solicitação
RequestId True string

ID da Solicitação

Retornos

Nome Caminho Tipo Description
codificar
code integer

codificar

mensagem
message string

mensagem

status
status string

status

Gatilhos

Gatilhos de sinal do Zoho

Registrar um retorno de chamada para um evento específico

Gatilhos de sinal do Zoho

Registrar um retorno de chamada para um evento específico

Parâmetros

Nome Chave Obrigatório Tipo Description
Ações
webhook_actions True string

Ações de webhook

Retornos

Nome Caminho Tipo Description
request_status
requests.request_status string

status da solicitação

notas
requests.notes string

notas

reminder_period
requests.reminder_period integer

período de lembrete

owner_id
requests.owner_id string

ID do proprietário

descrição
requests.description string

descrição

request_name
requests.request_name string

Nome da solicitação

modified_time
requests.modified_time integer

Tempo modificado

action_time
requests.action_time integer

Tempo de ação

is_deleted
requests.is_deleted boolean

Status de excluído

expiration_days
requests.expiration_days integer

Dias de expiração

is_sequential
requests.is_sequential boolean

Status da operação sequencial

sign_submitted_time
requests.sign_submitted_time integer

Hora de envio do sinal

owner_first_name
requests.owner_first_name string

Proprietário do nome

sign_percentage
requests.sign_percentage integer

Porcentagem de sinal

expire_by
requests.expire_by integer

Expirar por

owner_email
requests.owner_email string

Email do proprietário

created_time
requests.created_time integer

Tempo de criação

email_reminders
requests.email_reminders boolean

Lembretes de email

document_ids
requests.document_ids array of object

Lista de IDs de documento

document_name
requests.document_ids.document_name string

Insira o nome do documento

document_size
requests.document_ids.document_size integer

Tamanho do documento

document_order
requests.document_ids.document_order string

Ordem do documento

total_pages
requests.document_ids.total_pages integer

Número total de páginas no documento

document_id
requests.document_ids.document_id string

ID do documento

self_sign
requests.self_sign boolean

Status do autoassinamento

in_process
requests.in_process boolean

Status do processo

validade
requests.validity integer

Validade

request_type_name
requests.request_type_name string

Nome do tipo de solicitação

decline_reason
requests.decline_reason string

Motivo do declínio

request_id
requests.request_id string

ID da solicitação

request_type_id
requests.request_type_id string

ID do tipo de solicitação

owner_last_name
requests.owner_last_name string

Sobrenome do proprietário

Ações
requests.actions array of object

Ações

verify_recipient
requests.actions.verify_recipient boolean

Verificar destinatário

action_type
requests.actions.action_type string

Tipo de ação

private_notes
requests.actions.private_notes string

Notas privadas

recipient_email
requests.actions.recipient_email string

Email do destinatário

allow_signing
requests.actions.allow_signing boolean

Status da assinatura

recipient_phonenumber
requests.actions.recipient_phonenumber string

Número de telefone do destinatário

is_bulk
requests.actions.is_bulk boolean

Status da ação em massa

action_id
requests.actions.action_id string

ID da ação

is_revoked
requests.actions.is_revoked boolean

Status da revogação

is_embedded
requests.actions.is_embedded boolean

Status da inserção

signing_order
requests.actions.signing_order integer

Ordem de assinatura

recipient_name
requests.actions.recipient_name string

Nome do destinatário

action_status
requests.actions.action_status string

Status da ação

recipient_countrycode
requests.actions.recipient_countrycode string

Código do país do destinatário

performed_by_email
notifications.performed_by_email string

Executado por email

performed_at
notifications.performed_at integer

Executado em

reason
notifications.reason string

Reason

atividade
notifications.activity string

Activity

operation_type
notifications.operation_type string

Tipo de operação

action_id
notifications.action_id string

ID da ação

performed_by_name
notifications.performed_by_name string

Executado pelo nome

signing_order
notifications.signing_order integer

Ordem de assinatura

ip_address
notifications.ip_address string

Endereço IP

Definições

arquivo

Esse é o tipo de dados básico 'file'.

objeto

Esse é o tipo 'object'.