Annature (Editora Independente) (Pré-visualização)
A Annature é a principal solução de assinatura eletrônica de propriedade australiana com um provedor de assinatura digital integrado. Esse conector ajuda as empresas a criar envelopes e integrar o fluxo de trabalho de assinatura de documentos annature usando a API Annature (v1).
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 | Dr. Adrian Colquhoun (Estrategista) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| adrian@strategik.com.au |
| Metadados do conector | |
|---|---|
| Editora | Dr. Adrian Colquhoun (Estrategista) |
| Sítio Web | https://annature.com.au |
| Política de privacidade | https://www.annature.com.au/privacy-policy |
| Categorias | Produtividade |
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 |
|---|---|---|---|
| Annature Id | cadeia (de caracteres) | Annature Id | Verdade |
| Chave Annature | securestring | Chave Annature | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Criar envelope |
Criar envelope |
| Criar envelope a partir do modelo |
Usar modelo |
| Envelope vazio |
Enviar envelope |
| Enviar envelope |
Enviar envelope |
| Excluir envelope |
Excluir envelope |
| Obter campo |
Obter campo |
| Obter campos |
Listar todos os campos |
| Obter contas |
Listar todas as contas |
| Obter destinatário |
Obter um único destinatário criado para um envelope usando a propriedade id que foi retornada no corpo de resposta Criar um envelope |
| Obter documentos |
Listar todos os documentos de um envelope |
| Obter envelope |
Obter envelope |
| Obter envelopes |
Listar todos os envelopes |
| Obter modelo |
Obter modelo |
| Obter modelos |
Listar todos os modelos |
| Obter organização |
Obter organização |
| Obter todos os anexos para um campo |
Obter anexos de campo |
Criar envelope
Criar envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome do envelope, exibido no assunto dos e-mails enviados aos destinatários e ao visualizar o envelope |
|
Message
|
message | string |
Message |
|
|
Partilhado
|
shared | boolean |
Partilhado |
|
|
É rascunho
|
draft | boolean |
É rascunho |
|
|
ID da conta
|
account_id | True | string |
ID da conta |
|
ID do Grupo
|
group_id | string |
ID do Grupo |
|
|
ID do Grupo
|
id | string |
ID do Grupo |
|
|
Nome
|
name | string |
Nome |
|
|
Tipo
|
type | string |
Tipo |
|
|
Conteúdo do Ficheiro
|
base | byte |
Conteúdo do Ficheiro |
|
|
Nome
|
name | string |
Nome |
|
|
ID de e-mail
|
string |
ID de e-mail |
||
|
Telemóvel
|
mobile | string |
Telemóvel |
|
|
Tipo de destinatário
|
type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
|
Message
|
message | string |
Message |
|
|
palavra-passe
|
password | string | ||
|
Mudo?
|
muted | boolean |
Isso impedirá a Annature de enviar qualquer correspondência para o destinatário |
|
|
Ordem de Assinatura
|
order | integer |
Ordem de Assinatura |
|
|
Sessão Concluída
|
session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
|
Sessão recusada
|
session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
|
|
id
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
tipo
|
type | string |
O tipo de campo |
|
|
página
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
Obrigatório
|
required | boolean |
Obrigatório |
|
|
Somente leitura
|
read_only | boolean |
Somente leitura |
|
|
Colaborativo
|
collaborative | boolean |
Colaborativo |
|
|
Largura
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
Os valores possíveis são courier e helvetica |
|
|
criado
|
created | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
estado
|
status | string |
Situação |
|
Partilhado
|
shared | boolean |
Partilhado |
|
Criado em
|
created | string |
Criado em |
|
Enviado em
|
sent | string |
Enviado em |
|
anulada
|
voided | ||
|
recusou
|
declined | ||
|
concluída
|
completed | ||
|
ID da conta
|
account_id | string |
Account_id |
|
ID do Grupo
|
group_id | string |
ID do Grupo |
|
recipients
|
recipients | array of object | |
|
id
|
recipients.id | string | |
|
nome
|
recipients.name | string | |
|
e-mail
|
recipients.email | string | |
|
móvel
|
recipients.mobile | string | |
|
tipo
|
recipients.type | string | |
|
estado
|
recipients.status | string | |
|
mensagem
|
recipients.message | string | |
|
Palavra-passe
|
recipients.password |
Palavra-passe |
|
|
Mudo
|
recipients.muted | boolean |
Mudo |
|
order
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
criado
|
recipients.created | string | |
|
enviado
|
recipients.sent | string | |
|
recusou
|
recipients.declined | ||
|
concluída
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Criar envelope a partir do modelo
Usar modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
id | True | string |
ID do modelo |
|
Nome
|
name | string |
O nome do envelope, exibido no assunto dos e-mails enviados aos destinatários e ao visualizar o envelope |
|
|
É rascunho
|
draft | boolean |
É rascunho |
|
|
Message
|
message | string |
Message |
|
|
Partilhado
|
shared | boolean |
Partilhado |
|
|
ID da conta
|
account_id | True | string |
ID da conta |
|
ID do Grupo
|
group_id | string |
ID do Grupo |
|
|
ID do Grupo
|
id | string |
ID do Grupo |
|
|
Nome
|
name | string |
Nome |
|
|
ID do Grupo
|
type | string |
ID do Grupo |
|
|
Conteúdo do Ficheiro
|
base | byte |
Conteúdo do Ficheiro |
|
|
ID da função
|
role_id | string |
ID da função |
|
|
Nome
|
name | string |
Nome |
|
|
ID de e-mail
|
string |
ID de e-mail |
||
|
Telemóvel
|
mobile | string |
Telemóvel |
|
|
Autenticação por SMS
|
sms_auth | string |
Autenticação por SMS |
|
|
Tipo de destinatário
|
type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
|
Message
|
message | string |
Message |
|
|
palavra-passe
|
password | string | ||
|
Mudo?
|
muted | boolean |
Isso impedirá a Annature de enviar qualquer correspondência para o destinatário |
|
|
Ordem de Assinatura
|
order | integer |
Ordem de Assinatura |
|
|
ID do campo (do modelo)
|
id | True | string |
Id do campo de modelo |
|
Valor
|
value | True | string |
Valor para este campo |
|
Ponto de extremidade de destino após o destinatário ter concluído o envelope
|
session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
|
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope
|
session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
compartilhada
|
shared | boolean |
É compartilhado? |
|
rascunho
|
draft | boolean | |
|
account_id
|
account_id | string |
ID da conta |
|
group_id
|
group_id | string |
ID do Grupo |
|
Documentação
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nome
|
documents.name | string |
Nome |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Mestre
|
documents.master | string |
Mestre |
|
Criado
|
documents.created | string |
Criado |
|
recipients
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
nome
|
recipients.name | string | |
|
e-mail
|
recipients.email | string | |
|
móvel
|
recipients.mobile | string | |
|
mensagem
|
recipients.message | string | |
|
palavra-passe
|
recipients.password | boolean | |
|
silenciado
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Envelope vazio
Enviar envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Enviar envelope
Enviar envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Excluir envelope
Excluir envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Obter campo
Obter campo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
ID do campo
|
id | True | string |
ID do campo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
recipient_id
|
recipient_id | string |
ID do destinatário |
|
tipo
|
type | string |
Tipo |
|
página
|
page | integer | |
|
âncora
|
anchor | string |
Anchor |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obrigatório
|
required | boolean |
Obrigatório |
|
Read_only
|
read_only | boolean |
Read_only |
|
Colaborativo
|
collaborative | boolean |
Permite que outros destinatários no envelope modifiquem os valores |
|
valor
|
value | string |
O valor do campo |
|
Verificado
|
checked | boolean |
Verificado |
|
altura
|
height | integer | |
|
Largura
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
Os valores possíveis são courier e helvetica |
|
date_format
|
date_format | string |
Formato de data |
|
criado
|
created | string |
Criado |
Obter campos
Listar todos os campos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
tipo
|
type | string | |
|
página
|
page | integer | |
|
âncora
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Obrigatório
|
required | boolean |
Obrigatório |
|
Read_only
|
read_only | boolean |
Read_only |
|
Colaborativo
|
collaborative | boolean |
Colaborativo |
|
valor
|
value | string | |
|
Verificado
|
checked | boolean |
Verificado |
|
altura
|
height | integer | |
|
Largura
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
criado
|
created | string |
Obter contas
Listar todas as contas
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Nome
|
name | string |
Nome |
|
Email
|
string |
|
|
|
número
|
number | string | |
|
timezone
|
timezone | string | |
|
função
|
role | string | |
|
active
|
active | boolean | |
|
group_id
|
group_id | string | |
|
criado
|
created | string | |
|
verificada
|
verified | string |
Obter destinatário
Obter um único destinatário criado para um envelope usando a propriedade id que foi retornada no corpo de resposta Criar um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
ID do destinatário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
e-mail
|
string |
|
|
|
móvel
|
mobile | string |
Telemóvel |
|
tipo
|
type | string |
Tipo |
|
estado
|
status | string |
Situação |
|
mensagem
|
message | string |
Message |
|
Palavra-passe
|
password |
Palavra-passe |
|
|
Mudo
|
muted | boolean |
Mudo |
|
order
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
criado
|
created | string |
Criado |
|
enviado
|
sent | string |
Enviado |
|
recusou
|
declined | string |
Recusado |
|
concluída
|
completed | string |
Concluído |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
Obter documentos
Listar todos os documentos de um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
Duração do Endpoint
|
endpoint_duration | integer |
Define o número de minutos pelos quais os pontos de extremidade originais e mestres estarão acessíveis. O número pode variar entre 1 e 10080, com o padrão sendo 60 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
Id |
|
Nome
|
name | string |
Nome |
|
pages
|
pages | integer | |
|
Original
|
original | string |
Original |
|
Mestre
|
master | string |
Mestre |
|
Criado
|
created | string |
Criado |
Obter envelope
Obter envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
|
Duração do Endpoint
|
endpoint_duration | integer |
Define o número de minutos pelos quais os pontos de extremidade originais e mestres estarão acessíveis. O número pode variar entre 1 e 10080, com o padrão sendo 60 |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
estado
|
status | string |
Situação |
|
compartilhada
|
shared | boolean |
Partilhado |
|
criado
|
created | string |
Criado |
|
enviado
|
sent | string |
Enviado |
|
anulada
|
voided | string |
Esvaziado |
|
recusou
|
declined | string |
Recusado |
|
concluída
|
completed | string |
Concluído |
|
master
|
master | string |
Mestre |
|
combinado
|
combined | string |
Combinado |
|
certificado
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID da conta |
|
group_id
|
group_id | string |
ID do Grupo |
|
Destinatários
|
recipients | array of object | |
|
Nome
|
recipients.name | string |
Nome |
|
ID de e-mail
|
recipients.email | string |
ID de e-mail |
|
Telemóvel
|
recipients.mobile | string |
Telemóvel |
|
Tipo de destinatário
|
recipients.type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
Message
|
recipients.message | string |
Message |
|
Palavra-passe
|
recipients.password | ||
|
Mudo?
|
recipients.muted | boolean |
Isso impedirá a Annature de enviar qualquer correspondência para o destinatário |
|
Ordem de Assinatura
|
recipients.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário ter concluído o envelope
|
recipients.redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope
|
recipients.redirects.session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
|
campos
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
tipo
|
recipients.fields.type | string | |
|
página
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obrigatório
|
recipients.fields.required | boolean |
Obrigatório |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Colaborativo
|
recipients.fields.collaborative | boolean |
Colaborativo |
|
Largura
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
criado
|
recipients.fields.created | string |
Obter envelopes
Listar todos os envelopes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do envelope
|
name | string |
Um filtro de correspondência exata na lista com base na propriedade name do envelope |
|
|
Estado do envelope
|
status | string |
Um filtro de correspondência exata na lista com base no status do envelope |
|
|
Nome do destinatário
|
recipient | string |
Um filtro de correspondência exata na lista com base no nome ou propriedade de e-mail de qualquer destinatário |
|
|
Criado antes
|
created_before | date |
Devolve resultados em que a data de criação é anterior ao valor fornecido |
|
|
Criado após
|
created_after | date |
Devolve resultados em que a data de criação é posterior ao valor fornecido |
|
|
Concluído antes
|
completed_before | date |
Devolve resultados em que a data de conclusão é anterior ao valor fornecido |
|
|
Concluído após
|
completed_after | date |
Devolve resultados em que a data de conclusão é posterior ao valor fornecido |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
estado
|
status | string |
Situação |
|
compartilhada
|
shared | boolean |
Partilhado |
|
criado
|
created | string |
Criado |
|
enviado
|
sent | string |
Enviado |
|
anulada
|
voided | string |
Esvaziado |
|
recusou
|
declined | string |
Recusado |
|
concluída
|
completed | string |
Concluído |
|
combinado
|
combined | string |
Combinado |
|
master
|
master | string |
Mestre |
|
certificado
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
ID da conta |
|
group_id
|
group_id | string |
ID do Grupo |
|
Destinatários
|
recipients | array of object | |
|
Nome
|
recipients.name | string |
Nome |
|
ID de e-mail
|
recipients.email | string |
ID de e-mail |
|
Telemóvel
|
recipients.mobile | string |
Telemóvel |
|
Tipo de destinatário
|
recipients.type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
Message
|
recipients.message | string |
Message |
|
Palavra-passe
|
recipients.password | ||
|
Mudo?
|
recipients.muted | boolean |
Isso impedirá a Annature de enviar qualquer correspondência para o destinatário |
|
Ordem de Assinatura
|
recipients.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário ter concluído o envelope
|
recipients.redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope
|
recipients.redirects.session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
|
campos
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
tipo
|
recipients.fields.type | string | |
|
página
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Obrigatório
|
recipients.fields.required | boolean |
Obrigatório |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Colaborativo
|
recipients.fields.collaborative | boolean |
Colaborativo |
|
Largura
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
criado
|
recipients.fields.created | string |
Obter modelo
Obter modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
id | True | string |
ID do modelo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
Partilhado
|
shared | boolean |
Partilhado |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
criado
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentação
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nome
|
documents.name | string |
Nome |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Mestre
|
documents.master | string |
Mestre |
|
Criado
|
documents.created | string |
Criado |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nome
|
roles.name | string |
Nome |
|
Nome do destinatário
|
roles.recipient_name | string |
Nome do destinatário |
|
E-mail do destinatário
|
roles.recipient_email | string |
E-mail do destinatário |
|
Destinatário móvel
|
roles.recipient_mobile | string |
Destinatário móvel |
|
Tipo de destinatário
|
roles.recipient_type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
Palavra-passe
|
roles.recipient_password | string |
Palavra-passe |
|
Ordem de Assinatura
|
roles.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário ter concluído o envelope
|
roles.recipient_redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope
|
roles.recipient_redirects.session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
Obter modelos
Listar todos os modelos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | string |
Um filtro de correspondência exata na lista com base nos modelos |
|
|
Criado antes
|
created_before | date |
Devolve resultados em que a data de criação é anterior ao valor fornecido |
|
|
Criado após
|
created_after | date |
Devolve resultados em que a data de criação é posterior ao valor fornecido |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
nome
|
name | string | |
|
Partilhado
|
shared | boolean |
Partilhado |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
criado
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentação
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Nome
|
documents.name | string |
Nome |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Mestre
|
documents.master | string |
Mestre |
|
Criado
|
documents.created | string |
Criado |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Nome
|
roles.name | string |
Nome |
|
Nome do destinatário
|
roles.recipient_name | string |
Nome do destinatário |
|
E-mail do destinatário
|
roles.recipient_email | string |
E-mail do destinatário |
|
Destinatário móvel
|
roles.recipient_mobile | string |
Destinatário móvel |
|
Tipo de destinatário
|
roles.recipient_type | string |
O tipo de destinatário, o padrão é signatário quando não é fornecido |
|
Palavra-passe
|
roles.recipient_password | string |
Palavra-passe |
|
Ordem de Assinatura
|
roles.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário ter concluído o envelope
|
roles.recipient_redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário ter concluído o envelope |
|
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope
|
roles.recipient_redirects.session_declined | string |
Ponto de extremidade de destino depois que o destinatário se recusou a assinar o envelope |
Obter organização
Obter organização
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Id |
|
nome
|
name | string |
Nome |
|
negócios
|
business | string |
Negócios |
|
e-mail
|
string |
|
|
|
número
|
number | string |
Número |
|
address
|
address | string |
Address |
|
site
|
website | string |
Sítio Web |
|
logótipo
|
logo | string |
Logótipo |
|
cor
|
colour | string |
Cor |
|
criado
|
created | string |
Criado |
Obter todos os anexos para um campo
Obter anexos de campo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
ID do campo
|
id | True | string |
ID do campo |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Original
|
original | string | |
|
nome
|
name | string | |
|
tipo
|
type | string | |
|
size
|
size | integer | |
|
criado
|
created | string |
Acionadores
| Gatilho de Evento - Envelope e Destinatário |
Aciona quando um evento ocorre quando envelopes são concluídos ou o destinatário é visualizado |
Gatilho de Evento - Envelope e Destinatário
Aciona quando um evento ocorre quando envelopes são concluídos ou o destinatário é visualizado
Devoluções
- Body
- WebhookEventContent
Definições
WebhookEventContent
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
evento
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
anulada
|
voided | string | |
|
concluída
|
completed | string | |
|
master
|
master | string | |
|
certificado
|
certificate | string | |
|
enviado
|
sent | string | |
|
método
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
visualizado
|
viewed | string | |
|
recusou
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
com falhas
|
failed | string | |
|
Diagnóstico
|
diagnosis | string |