Partilhar via


Sinal Zoho

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte à API do Zoho Sign
URL https://www.zoho.com/sign/contact.html
Email support@zohosign.com
Metadados do conector
Editora Zoho Corporação
Sítio Web https://www.zoho.com/sign/
Política de privacidade https://www.zoho.com/privacy.html
Categorias Conteúdos e Ficheiros; Produtividade

Assine digitalmente documentos de negócios on-line com total segurança e confiabilidade usando o software de assinatura eletrônica da Zoho. Automatize suas transações com fluxos de trabalho simples de documentos de assinatura eletrônica. Um aplicativo de assinatura digital completo para signatários de negócios.

Pré-requisitos

Para usar este 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 OAuth 2 para autenticar. Assim, uma vez que a conta é configurada, nenhuma etapa adicional é necessária.

Todas as APIs do Zoho Sign exigem este cabeçalho obrigatório: Authorization - Authentication request header.

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

Introdução ao conector

O Zoho Sign Connector oferece a opção para que os usuários executem gerenciamento de documentos, 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 SUPORTADAS?" no link abaixo,

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

Esses conectores ajudarão você a automatizar o uso, desde o envio do documento ou modelo até o rastreamento de status e muito mais.

Erros e soluções comuns

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

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) Selecione o domínio. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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

Criar um documento para assinatura

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

Descarregar documento

Descarrega um envelope específico

Descarregar Ficheiro

Transfere um documento ou ficheiro específico

Download do Certificado de Conclusão

Faz o download do certificado de conclusão de um envelope específico

Excluir documento

Eliminar um documento específico

Invocar API

Invocar API

Lembrete para destinatários

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

Obter dados do pedido concluído

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 documentos criados

Obter um documento

Mostra os detalhes de um envelope específico

Revogar um documento específico

Revogar um documento 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

Name Chave Necessário Tipo Description
ID de solicitação
RequestId True string

ID de solicitação

Tipo de documento
request_type_id string

request_type_id

Nome do documento
request_name True string

Nome do documento (pedido)

Nome do destinatário
recipient_name string

Nome do destinatário

E-mail do destinatário
recipient_email string

E-mail do destinatário

Número de Telefone
recipient_phonenumber string

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

Código do país
recipient_countrycode string

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

Tipo de ação
action_type string

Selecione se o destinatário é um signatário ou um visualizador, 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 o 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 por encomenda
is_sequential boolean

Permitir que os destinatários entrem na ordem especificada.

Lembretes automáticos
email_reminders boolean

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

Envie 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.

Folder
folder_id string

ID exclusivo da pasta

Observações
notes html

Notas para todos os destinatários.

Devoluções

Name Caminho Tipo Description
código
code integer

código

mensagem
message string

mensagem

estado
status string

estado

Criar um documento para assinatura

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

Parâmetros

Name Chave Necessário Tipo Description
Criar um documento
file True file

Criar um documento

Devoluções

Name Caminho Tipo Description
código
code integer

código

request_status
requests.request_status string

Situação do pedido

owner_email
requests.owner_email string

E-mail do proprietário

created_time
requests.created_time integer

Tempo criado

document_ids
requests.document_ids array of object

document_ids

image_string
requests.document_ids.image_string string

Cadeia de caracteres da imagem

document_name
requests.document_ids.document_name string

Nome do documento

pages
requests.document_ids.pages array of object

pages

image_string
requests.document_ids.pages.image_string string

Cadeia de caracteres da 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 de documentos

total_pages
requests.document_ids.total_pages integer

Total de páginas

document_id
requests.document_ids.document_id string

ID do documento

Observações
requests.notes string

Observações

self_sign
requests.self_sign boolean

auto-sinal

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 do pedido

modified_time
requests.modified_time integer

tempo modificado

is_deleted
requests.is_deleted boolean

Estado da supressão

expiration_days
requests.expiration_days integer

Dias de validade

in_process
requests.in_process boolean

Em processamento

is_sequential
requests.is_sequential boolean

Estado 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

id_de_pedido
requests.request_id string

ID do pedido

request_type_id
requests.request_type_id string

ID do tipo de pedido

owner_last_name
requests.owner_last_name string

Proprietário Apelido

sign_percentage
requests.sign_percentage integer

Percentagem de sinais

mensagem
message string

Message

estado
status string

estado

Descarregar documento

Descarrega um envelope específico

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

Devoluções

response
file

Descarregar Ficheiro

Transfere um documento ou ficheiro específico

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

ID do documento
document_id True integer

ID do documento

Devoluções

response
file

Download do Certificado de Conclusão

Faz o download do certificado de conclusão de um envelope específico

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

Devoluções

response
file

Excluir documento

Eliminar um documento específico

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

Invocar API

Invocar API

Parâmetros

Name Chave Necessário Tipo Description
Caminho da URL
url True string

Fornecer caminho url

Método
method True string

Selecione o método API a ser usado

Devoluções

response
object

Lembrete para destinatários

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

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

Obter dados do pedido concluído

Mostra os detalhes de um envelope assinado

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID do pedido

Devoluções

Name Caminho Tipo Description
código
code integer

código

request_name
document_form_data.request_name string

Nome do pedido

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

E-mail do destinatário

recipient_name
document_form_data.actions.recipient_name string

Nome do destinatário

campos
document_form_data.actions.fields array of object

campos

field_label
document_form_data.actions.fields.field_label string

Rótulo do 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

estado
status string

estado

Obter detalhes específicos do modelo

Mostra os detalhes de um modelo de documento específico

Parâmetros

Name Chave Necessá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 documentos criados

Devoluções

Name 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

Name Chave Necessário Tipo Description
ID de solicitação
RequestId True integer

ID de solicitação

Devoluções

Name Caminho Tipo Description
código
code integer

código

request_status
requests.request_status string

Situação do pedido

Observações
requests.notes string

Observaçõ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 do pedido

request_name
requests.request_name string

Nome do pedido

modified_time
requests.modified_time integer

Hora da Modificação

action_time
requests.action_time integer

Tempo de ação

is_deleted
requests.is_deleted boolean

Excluir status da solicitação

expiration_days
requests.expiration_days integer

Dias de validade

is_sequential
requests.is_sequential boolean

Status sequencial

sign_submitted_time
requests.sign_submitted_time integer

Assinar a hora submetida

owner_first_name
requests.owner_first_name string

Nome próprio do proprietário

sign_percentage
requests.sign_percentage float

Percentagem de sinais

expire_by
requests.expire_by integer

Data de validade do documento

is_expiring
requests.is_expiring boolean

Documento que expira em

owner_email
requests.owner_email string

ID de e-mail do proprietário

created_time
requests.created_time integer

Hora em que o documento foi criado

email_reminders
requests.email_reminders boolean

Enviar lembretes por e-mail

document_ids
requests.document_ids array of object

IDs do documento

image_string
requests.document_ids.image_string string

Cadeia de caracteres da imagem

document_name
requests.document_ids.document_name string

Nome do documento

pages
requests.document_ids.pages array of object

pages

image_string
requests.document_ids.pages.image_string string

Cadeia de caracteres da 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 de documentos

total_pages
requests.document_ids.total_pages integer

N.º total de páginas do documento

document_id
requests.document_ids.document_id string

ID do documento

self_sign
requests.self_sign boolean

Estado de auto-assinatura

sign_id
requests.sign_id string

ID do sinal

folder_name
requests.folder_name string

Nome da pasta

in_process
requests.in_process boolean

Estado em 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

id_de_pedido
requests.request_id string

ID do pedido

request_type_id
requests.request_type_id string

ID do tipo de pedido

owner_last_name
requests.owner_last_name string

Apelido do proprietário

ações
requests.actions array of object

ações

verify_recipient
requests.actions.verify_recipient boolean

Verificar o ID de 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 e-mail do destinatário

send_completed_document
requests.actions.send_completed_document boolean

Estado 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

Estatuto do volume

action_id
requests.actions.action_id string

Id da ação

is_revoked
requests.actions.is_revoked boolean

Estado da revogação

is_embedded
requests.actions.is_embedded boolean

Estado dos incorporados

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

Estado da ação

recipient_countrycode
requests.actions.recipient_countrycode string

Código do país do destinatário

Ishost
requests.actions.ishost boolean

Estado de utilização do anfitrião

linguagem
requests.actions.language string

linguagem

in_person_name
requests.actions.in_person_name string

Nome pessoal

in_person_email
requests.actions.in_person_email string

E-mail presencial

verification_code
requests.actions.verification_code string

Código de verificação

attachment_size
requests.attachment_size integer

Tamanho do acessório

mensagem
message string

mensagem

estado
status string

estado

Revogar um documento específico

Revogar um documento específico

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
request_id True integer

ID de solicitação

SendSignRequest

Enviar o documento carregado para assinatura

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
RequestId True string

ID de solicitação

Devoluções

Name Caminho Tipo Description
código
code integer

código

mensagem
message string

mensagem

estado
status string

estado

Acionadores

Gatilhos do Zoho Sign

Registrar um retorno de chamada para um evento específico

Gatilhos do Zoho Sign

Registrar um retorno de chamada para um evento específico

Parâmetros

Name Chave Necessário Tipo Description
Ações
webhook_actions True string

Ações do Webhook

Devoluções

Name Caminho Tipo Description
request_status
requests.request_status string

Estado do pedido

Observações
requests.notes string

Observações

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 do pedido

modified_time
requests.modified_time integer

Tempo modificado

action_time
requests.action_time integer

Tempo de ação

is_deleted
requests.is_deleted boolean

Estado dos suprimidos

expiration_days
requests.expiration_days integer

Dias de validade

is_sequential
requests.is_sequential boolean

Estado da operação sequencial

sign_submitted_time
requests.sign_submitted_time integer

Assinar a hora submetida

owner_first_name
requests.owner_first_name string

Dono do primeiro nome

sign_percentage
requests.sign_percentage integer

Percentagem de sinais

expire_by
requests.expire_by integer

Expira em

owner_email
requests.owner_email string

E-mail do proprietário

created_time
requests.created_time integer

Tempo criado

email_reminders
requests.email_reminders boolean

Lembretes por e-mail

document_ids
requests.document_ids array of object

Lista de IDs de documentos

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 do documento

document_id
requests.document_ids.document_id string

ID do documento

self_sign
requests.self_sign boolean

Estado do auto-sinal

in_process
requests.in_process boolean

Situação do em 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 de recusa

id_de_pedido
requests.request_id string

ID do pedido

request_type_id
requests.request_type_id string

ID do tipo de pedido

owner_last_name
requests.owner_last_name string

Apelido 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

E-mail do destinatário

allow_signing
requests.actions.allow_signing boolean

Estado 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

Estado da revogação

is_embedded
requests.actions.is_embedded boolean

Estado dos incorporados

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

Estado 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

Realizado por e-mail

performed_at
notifications.performed_at integer

Realizado na

razão
notifications.reason string

Reason

actividade
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

ficheiro

Este é o tipo de dados básicos 'arquivo'.

objecto

Este é o tipo 'objeto'.