Sinal OGM
O GMO Sign Connector ajuda as organizações a se conectarem e automatizarem a forma como preparam, assinam, agem e gerenciam contratos.
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 | Sinal Global de OGM |
| URL | https://www.gmosign.com/ |
| Metadados do conector | |
|---|---|
| Editora | OGM GlobalSign Holdings K.K. |
| Sítio Web | https://secure.gmosign.com/ |
| Política de privacidade | https://www.gmogshd.com/privacy |
| Categorias | Conteúdos e Ficheiros; Produtividade |
Informações sobre o conector GMOSign
"GMOSign" é um serviço de contratação electrónica de primeira classe.
O "GMO Sign connector" ajuda as organizações a conectar e automatizar o fluxo de contratação (preparar, assinar e gerenciar acordos) no "GMO Sign".
Pré-requisitos
Para usar esse conector, você precisa de uma conta GMO Sign válida com a opção API ativada.
Entre em contato com o Suporte do GMOSign para obter mais detalhes, pois o aplicativo necessário será diferente dependendo do método de uso.
Como obter credenciais
O ID do cliente e a chave privada da API serão as credenciais do conector.
Para obter as credenciais, entre em contato com o suporte do GMO Sin e assine os Planos de API para PowerAutomate.
Introdução ao conector
Visite o Centro de Ajuda do GMOSign para obter os detalhes do Power Automate Connector.
Operações suportadas
Solicitação de assinatura usando um modelo existente -> Crie uma solicitação de assinatura usando um modelo existente disponível no GMO Sign acccount.
Solicitação de assinatura carregando novo(s) documento(s) -> Crie uma solicitação de assinatura carregando novo(s) documento(s).
Criar gancho de envelope -> Crie um gancho para os envelopes solicitados para obter o status de assinatura.
Obter os documentos assinados -> Obtenha os documentos assinados disponíveis na conta GMO Sign usando o ID dos documentos.
Problemas conhecidos e limitações
A partir de agora, não há problemas conhecidos com este conector.
Erros e soluções comuns
Por favor, verifique Contacte-nos para quaisquer problemas e suas soluções.
FAQ
Visite o Centro de Ajuda do GMOSign
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 |
|---|---|---|---|
| ID do Cliente | securestring | ID do Cliente | Verdade |
| Chave Secreta | securestring | Chave secreta da API | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Enviar um novo envelope usando um modelo especificado |
Envie um novo envelope usando um modelo especificado. |
| Obter documentos envelope |
Obtenha documentos envelope. |
| Registar um documento envelope |
Registe um novo envelope documental. |
| Registrar um documento envelope para tamanho enorme |
Registe um novo envelope documental. |
| Solicitar assinatura de envelope |
Solicite uma assinatura de envelope. |
Enviar um novo envelope usando um modelo especificado
Envie um novo envelope usando um modelo especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | string |
ID do modelo |
|
Nome do envelope
|
envelope_name | True | string | |
|
Nome do remetente
|
sender_name | string | ||
|
Nome do departamento do remetente
|
sender_post_name | string | ||
|
Notificação de conclusão da assinatura
|
is_compliation_mail | integer |
enviar um e-mail de notificação de conclusão para o remetente |
|
|
Acionador
|
is_web_hook | True | integer |
Acione um gatilho PowerAutomate ao concluir a assinatura |
|
Destino da notificação de erro de envio de e-mail
|
bounced_note_mail | string | ||
|
Ordem de aprovação
|
order_no | string | ||
|
Approver
|
name | string | ||
|
Afiliação do aprovador
|
post_name | string | ||
|
Email
|
string | |||
|
Comentário de aprovação
|
work_flow_comment | string | ||
|
Tipo de signatário
|
signer_type | True | integer | |
|
Utilização do modelo
|
use_template | integer |
Se deve usar o signatário registrado no modelo |
|
|
Ordem dos signatários
|
order_no | string | ||
|
Tipo de assinatura
|
sign_type | True | integer | |
|
Nome do signatário
|
name | string | ||
|
Afiliação do signatário
|
organize_name | string | ||
|
Email
|
string | |||
|
Comments
|
comment | string | ||
|
Código de acesso
|
access_code | string | ||
|
autoridade de mudança
|
is_signer_change | integer |
Permitir que o destinatário altere o signatário? |
|
|
Imagem anexada
|
is_attached_file | integer |
Permitir que o signatário anexe uma imagem de sinal? |
|
|
Enviar e-mail
|
is_send_mail | integer |
Enviar um e-mail de solicitação de assinatura para o signatário |
|
|
Idioma do e-mail
|
language | string | ||
|
Tipo de pagamento
|
payment_type | integer |
Selecione um tipo de pagamento |
|
|
Taxa (JPN Yen)
|
amount | string | ||
|
Description
|
description | string | ||
|
Ano de início do pagamento
|
subscription_start_year | string | ||
|
Mês de início do pagamento
|
subscription_start_month | string | ||
|
Dia de início do pagamento
|
subscription_start_date | string | ||
|
Recetor
|
name | string | ||
|
Afiliação do destinatário
|
organize_name | string | ||
|
Email
|
string | |||
|
Comennts
|
comment | string | ||
|
Idioma do e-mail
|
language | string | ||
|
Mesclar nome do item
|
name | string | ||
|
Valor do item de mesclagem
|
value | string |
Devoluções
- Body
- SendEnvelopeResponse
Obter documentos envelope
Obtenha documentos envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
- Body
- GetDocumentsResponse
Registar um documento envelope
Registe um novo envelope documental.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Documento
|
document | True | binary |
Arquivos obtidos do SharePoint ou OneDrive. |
|
Código do documento
|
document_code | string | ||
|
Sinalizador de reutilização
|
reuse_flag | integer | ||
|
Observações
|
remarks | string |
Devoluções
Registrar um documento envelope para tamanho enorme
Registe um novo envelope documental.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Caminho do arquivo
|
file_path | True | string |
Caminho do arquivo após "/input/" do nome do arquivo no servidor SFTP. No AWS S3, a configuração é "s3://(bucket name)/(user name)/input/(file name)". |
|
Código do documento
|
document_code | string | ||
|
Sinalizador de reutilização
|
reuse_flag | integer | ||
|
Observações
|
remarks | string |
Devoluções
Solicitar assinatura de envelope
Solicite uma assinatura de envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do envelope
|
envelope_name | True | string | |
|
Nome do remetente
|
sender_name | string | ||
|
Nome da postagem do remetente
|
sender_post_name | string | ||
|
Enviar e-mail de compilação
|
is_compilation_mail | integer | ||
|
Enviar gancho da Web
|
is_web_hook | integer | ||
|
Correio de notas devolvido
|
bounced_note_mail | string | ||
|
Código do documento
|
document_code | True | string | |
|
Nome do documento
|
document_name | True | string | |
|
Início do ponto de texto x
|
fill_text_point_start_x | integer |
Se você inserir Preencher texto, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Início do ponto de texto y
|
fill_text_point_start_y | integer |
Se você inserir Preencher texto, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final x
|
fill_text_point_end_x | integer |
Se você inserir Preencher texto, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final y
|
fill_text_point_end_y | integer |
Se você inserir Preencher texto, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Página n.º
|
page_no | integer |
Se introduzir Preencher texto, é obrigatório. |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Preencher texto
|
fill_text | string |
Se introduzir Preencher texto, é obrigatório. |
|
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir o texto Data, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir o texto Data, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir o texto Data, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir o texto Data, ele será obrigatório e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Página n.º
|
page_no | integer |
Se você inserir o texto Data, ele será obrigatório. |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Texto da data
|
date_text | string |
Se você inserir o texto Data, ele será obrigatório. É necessário inserir no formato "AAAAmmdd". |
|
|
Tipo de caixa de seleção
|
check_box_type | string | ||
|
Ponto de caixa de seleção início x
|
check_box_point_start_x | integer |
Se você digitar a caixa de seleção, ela será obrigatória e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de caixa de seleção início y
|
check_box_point_start_y | integer |
Se você digitar a caixa de seleção, ela será obrigatória e somente números inteiros de 0 a 100 serão permitidos. |
|
|
Ponto de caixa de seleção final x
|
check_box_point_end_x | integer |
Se você digitar a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos |
|
|
Ponto de caixa de seleção final y
|
check_box_point_end_y | integer |
Se você digitar a caixa de seleção, ela será necessária e somente números inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você digitar a caixa de seleção, ela será obrigatória. |
|
|
N.º da encomenda
|
order_no | string |
Se você entrar na lista de signatários internos, é obrigatório. |
|
|
Ou assine
|
is_or_sign | integer | ||
|
Tipo de sinal
|
sign_type | integer |
Se você entrar na lista de signatários internos, é obrigatório. |
|
|
Email
|
string |
Se você entrar na lista de signatários internos, é obrigatório. |
||
|
Comment
|
comment | string | ||
|
Código de acesso
|
access_code | string |
Se você definir sign_type "Tipo de selo de contrato", é opcional. |
|
|
Alteração de signatário
|
is_signer_change | integer |
Se você definir sign_type "Tipo de selo de contrato", é opcional. |
|
|
Ficheiro anexado
|
is_attached_file | integer |
Está disponível apenas quando se inscreveu na opção "Anexo de imagem" e é opcional. |
|
|
Uso de verificação de formato de carteira de motorista
|
is_drivers_license_format_check_use | integer |
Ele está disponível e opcional somente quando você se inscreveu para a opção "Anexo de imagem" e definido para o tipo de assinatura "Tipo de selo de contrato". Não pode ser especificado por documento. Não pode ser combinado o uso com a alteração do signatário e, se você definir para Solicitação, digite "Verificação de documento, não enviar". |
|
|
Enviar e-mail
|
is_send_mail | integer | ||
|
Enviar e-mail de compilação
|
is_compilation_mail | integer | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o idioma definido para a conta de origem. |
|
|
N.º do signatário
|
signer_no | string |
Se você entrar na lista de documentos do envelope do signatário interno, é necessário e digite o mesmo texto que o e-mail deste e o signatário interno correspondente. |
|
|
Código do documento
|
document_code | string |
Se você inserir na lista de documentos de envelope do signatário interno, é necessário. |
|
|
Tipo de pedido
|
request_type | string |
Se você inserir na lista de documentos de envelope do signatário interno, é necessário. |
|
|
Ficheiro anexado ao documento
|
is_document_attached_file | integer | ||
|
Início do ponto de assinatura x
|
signing_text_point_start_x | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de assinatura y
|
signing_text_point_start_y | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final x
|
signing_text_point_end_x | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final y
|
signing_text_point_end_y | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Pontos de assinatura, é necessário |
|
|
Tag
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
free_text_point_start_x | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
free_text_point_start_y | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
free_text_point_end_x | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
free_text_point_end_y | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Ponto de texto livre, é necessário |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Texto de espaço reservado
|
placeholder_text | string | ||
|
Tag
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Texto de espaço reservado
|
placeholder_text | string | ||
|
Tag
|
tag | string | ||
|
Tipo de caixa de seleção
|
check_box_type | string |
Se você inserir Ponto de caixa de verificação, é necessário |
|
|
Ponto de caixa de seleção início x
|
check_box_point_start_x | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de caixa de seleção início y
|
check_box_point_start_y | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de caixa de seleção final x
|
check_box_point_end_x | integer |
Apenas números inteiros de 0-100 são permitidos |
|
|
Ponto de caixa de seleção final y
|
check_box_point_end_y | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
N.º da encomenda
|
order_no | string | ||
|
Ou assine
|
is_or_sign | integer | ||
|
Tipo de sinal
|
sign_type | integer |
Se você entrar na lista de signatários de parceiros, isso será obrigatório. |
|
|
Nome do signatário
|
name | string |
Se você entrar na lista de signatários de parceiros, isso será obrigatório. |
|
|
Organizar nome
|
organize_name | string | ||
|
Email
|
string |
O seu endereço de e-mail ou número de telefone (é possível se você usar a opção de envio de SMS) é necessário. |
||
|
Número de telefone
|
phone_number | string |
O seu endereço de e-mail ou número de telefone (é possível se você usar a opção de envio de SMS) é necessário. |
|
|
Data da permissão por telefone
|
phone_permit_date | string | ||
|
attendant_email
|
attendant_email | string |
Se você definir o tipo Assinar "Assinatura pessoalmente", é necessário. |
|
|
Comment
|
comment | string | ||
|
Código de acesso
|
access_code | string |
Se você definir o tipo de sinal "Assinatura em pessoa, Tipo de selo de contrato", ele é designável. |
|
|
Alteração de signatário
|
is_signer_change | integer | ||
|
Ficheiro anexado
|
is_attached_file | integer |
Ele está disponível somente quando você se inscreveu para a opção "Anexo de imagem". Se houver uma especificação em unidades de documento, ela tem precedência. (Se você definir o tipo de assinatura "Assinatura pessoalmente" e o tipo de solicitação "Verificação de documento", ele será considerado "1".) |
|
|
Uso de verificação de formato de carteira de motorista
|
is_drivers_license_format_check_use | integer |
Ele está disponível e opcional somente quando você se inscreveu para a opção "Anexo de imagem" e definido para o tipo de assinatura "Tipo de selo de contrato". Não pode ser especificado por documento. Não pode ser combinado o uso com a alteração do signatário e, se você definir para Solicitação, digite "Verificação de documento, não enviar". |
|
|
Enviar e-mail
|
is_send_mail | integer | ||
|
Enviar e-mail de compilação
|
is_compilation_mail | integer | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o idioma definido para a conta de origem. |
|
|
Tipo de pagamento
|
payment_type | integer |
Está disponível apenas quando se inscreveu na "opção de pagamento" e é opcional. |
|
|
Taxa (JPN Yen)
|
amount | string |
Se você definir o tipo de pagamento "Cada vez, regularmente", é necessário. |
|
|
Description
|
description | string | ||
|
Ano de início do pagamento
|
subscription_start_year | string |
Se você definir o tipo de pagamento "Regularmente", é necessário. |
|
|
Mês de início do pagamento
|
subscription_start_month | string |
Se você definir o tipo de pagamento "Regularmente", é necessário. |
|
|
Dia de início do pagamento
|
subscription_sale_date | string |
Se você definir o tipo de pagamento "Regularmente", é necessário. |
|
|
N.º do signatário
|
signer_no | string |
Se você inserir a lista de documentos do signatário do parceiro, ele será necessário e inserir o mesmo texto do e-mail ou número de telefone deste e do signatário do parceiro correspondente. |
|
|
Código do documento
|
document_code | string |
Se você inserir a lista de documentos do signatário do parceiro, ela será necessária |
|
|
Tipo de pedido
|
request_type | string |
Se você inserir a lista de documentos do signatário do parceiro, ela será necessária |
|
|
Ficheiro anexado ao documento
|
is_document_attached_file | integer | ||
|
Início do ponto de assinatura x
|
signing_text_point_start_x | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de assinatura y
|
signing_text_point_start_y | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final x
|
signing_text_point_end_x | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de assinatura final y
|
signing_text_point_end_y | integer |
Se você inserir Pontos de assinatura, isso será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Pontos de assinatura, é necessário |
|
|
Tag
|
tag | string | ||
|
Obrigatório
|
is_required | string | ||
|
Início do ponto de texto x
|
free_text_point_start_x | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
free_text_point_start_y | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
free_text_point_end_x | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
free_text_point_end_y | integer |
Se você inserir Ponto de texto livre, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Ponto de texto livre, é necessário |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Texto de espaço reservado
|
placeholder_text | string | ||
|
Tag
|
tag | string | ||
|
Obrigatório
|
is_required | string |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Início do ponto de texto x
|
date_text_point_start_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Início do ponto de texto y
|
date_text_point_start_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final x
|
date_text_point_end_x | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de texto final y
|
date_text_point_end_y | integer |
Se você inserir o ponto de texto Data, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir o ponto de texto Data, ele será necessário |
|
|
Tamanho do tipo de letra
|
font_size | double | ||
|
Texto de espaço reservado
|
placeholder_text | string | ||
|
Tag
|
tag | string | ||
|
Tipo de caixa de seleção
|
check_box_type | string |
Se você inserir Ponto de caixa de verificação, é necessário |
|
|
Ponto de caixa de seleção início x
|
check_box_point_start_x | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de caixa de seleção início y
|
check_box_point_start_y | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Ponto de caixa de seleção final x
|
check_box_point_end_x | integer |
Apenas números inteiros de 0-100 são permitidos |
|
|
Ponto de caixa de seleção final y
|
check_box_point_end_y | integer |
Se você inserir Ponto de caixa de verificação, ele será necessário e somente inteiros de 0 a 100 serão permitidos |
|
|
Página n.º
|
page_no | integer |
Se você inserir Ponto de caixa de verificação, é necessário |
|
|
ID da pasta
|
folder_id | integer | ||
|
N.º da encomenda
|
order_no | integer |
Se você designar um aprovador, ele será obrigatório. |
|
|
Nome
|
name | string |
Se você designar um aprovador, ele será obrigatório. |
|
|
Nome da publicação
|
post_name | string | ||
|
Email
|
string |
Se você designar um aprovador, ele será obrigatório. |
||
|
Comentário do fluxo de trabalho
|
workflow_comment | string | ||
|
Nome
|
name | string |
Se você designar um destinatário, ele será necessário. |
|
|
Organizar nome
|
organize_name | string | ||
|
Email
|
string |
Se você designar um destinatário, seu endereço de e-mail ou número de telefone SMS (é possível se você usar a opção de envio de SMS) é necessário. |
||
|
Número de telefone
|
phone_number | string |
Se você designar um destinatário, seu endereço de e-mail ou número de telefone SMS (é possível se você usar a opção de envio de SMS) é necessário. |
|
|
Data da permissão por telefone
|
phone_permit_date | string | ||
|
Comment
|
comment | string | ||
|
Linguagem
|
language | string |
Se você não inserir isso, aplique o idioma definido para a conta de origem. |
Devoluções
Acionadores
| Quando o status de um envelope muda (Conectar) |
Aciona um novo fluxo quando o status de um envelope é alterado. |
Quando o status de um envelope muda (Conectar)
Aciona um novo fluxo quando o status de um envelope é alterado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Título da conexão
|
name | True | string |
Devoluções
Definições
WebhookEnvelopeResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de documentos
|
document_list | array of object | |
|
ID do documento
|
document_list.documentId | string | |
|
Nome do documento
|
document_list.document_name | string | |
|
Nome do envelope
|
envelope_name | string | |
|
ID da transação do envelope
|
envelope_xid | string |
GetDocumentsResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documento descarregado
|
downloadedDocument | byte |
RegisterDocumentResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
Estado da resposta |
|
Result
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
Código do Documento
|
document_code | string |
código do documento |
RegisterDocumentForHugeSizeResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
Estado da resposta |
|
Result
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
Código do Documento
|
document_code | string |
código do documento |
RequestSignatureResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
Estado da resposta |
|
Result
|
result | string |
resultado da resposta |
|
Message
|
message | string |
mensagem de resposta |
|
ID da transação do envelope
|
envelope_xid | string |
envelope_xid |
|
Lista de documentos
|
document_list | array of document |
SendEnvelopeResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da transação do envelope
|
envelope_xid | string |
ID da transação do envelope |
|
Estado do envelope
|
envelope_status | string |
O status do envelope. |
|
Lista de documentos
|
document_list | array of document | |
|
Lista de signatários
|
signer_list | array of resSigner |
documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do documento
|
document_name | string | |
|
ID do documento
|
control_number | string |
resSigner
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ordem do signatário
|
order_no | string | |
|
Nome do signatário
|
name | string | |
|
Afiliação do signatário
|
organize_name | string | |
|
Email
|
string | ||
|
Telefone.
|
phone_number | string | |
|
ID do signatário do envelope
|
envelope_signer_id | string | |
|
Token do signatário do envelope
|
envelope_sign_token | string | |
|
Estado do sinal
|
sign_status | string |