Annature (Editor Independente) (versão prévia)
Annature é a principal solução de eSigning 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 do Annature (v1).
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 | Dr. Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| adrian@strategik.com.au |
| Metadados do conector | |
|---|---|
| Publicador | Dr. Adrian Colquhoun (Strategik) |
| Site | https://annature.com.au |
| Política de privacidade | https://www.annature.com.au/privacy-policy |
| Categorias | Produtividade |
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 |
|---|---|---|---|
| Annature Id | cadeia | Annature Id | Verdade |
| Chave Annature | secureString | Chave Annature | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Criar Envelope |
Criar Envelope |
| Criar envelope com base no modelo |
Usar Modelo |
| Envelope Nulo |
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 da resposta criar um envelope |
| Obter documentos |
Listar todos os documentos para 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 de um campo |
Obter anexos de campo |
Criar Envelope
Criar Envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome do envelope, exibido no assunto dos emails enviados aos destinatários e ao exibir o envelope |
|
Message
|
message | string |
Message |
|
|
Compartilhado
|
shared | boolean |
Compartilhado |
|
|
É rascunho
|
draft | boolean |
É rascunho |
|
|
AccountID
|
account_id | True | string |
AccountID |
|
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 arquivo
|
base | byte |
Conteúdo do arquivo |
|
|
Nome
|
name | string |
Nome |
|
|
Email Id
|
string |
Email Id |
||
|
Telemóvel
|
mobile | string |
Telemóvel |
|
|
Tipo de destinatário
|
type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
|
Message
|
message | string |
Message |
|
|
senha
|
password | string | ||
|
Abafado?
|
muted | boolean |
Isso impedirá Annature de enviar qualquer correspondência ao 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 concluir 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 |
|
|
criadas
|
created | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
status
|
status | string |
Situação |
|
Compartilhado
|
shared | boolean |
Compartilhado |
|
Data da criação
|
created | string |
Data da criação |
|
Enviado em
|
sent | string |
Enviado em |
|
Anulada
|
voided | ||
|
recusado
|
declined | ||
|
concluído
|
completed | ||
|
ID da conta
|
account_id | string |
Account_id |
|
ID do grupo
|
group_id | string |
ID do grupo |
|
destinatários
|
recipients | array of object | |
|
id
|
recipients.id | string | |
|
nome
|
recipients.name | string | |
|
email
|
recipients.email | string | |
|
móvel
|
recipients.mobile | string | |
|
tipo
|
recipients.type | string | |
|
status
|
recipients.status | string | |
|
mensagem
|
recipients.message | string | |
|
Senha
|
recipients.password |
Senha |
|
|
Abafado
|
recipients.muted | boolean |
Abafado |
|
ordem
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
criadas
|
recipients.created | string | |
|
enviado
|
recipients.sent | string | |
|
recusado
|
recipients.declined | ||
|
concluído
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Criar envelope com base no modelo
Usar Modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo
|
id | True | string |
ID do Modelo |
|
Nome
|
name | string |
O nome do envelope, exibido no assunto dos emails enviados aos destinatários e ao exibir o envelope |
|
|
É rascunho
|
draft | boolean |
É rascunho |
|
|
Message
|
message | string |
Message |
|
|
Compartilhado
|
shared | boolean |
Compartilhado |
|
|
AccountID
|
account_id | True | string |
AccountID |
|
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 arquivo
|
base | byte |
Conteúdo do arquivo |
|
|
ID da função
|
role_id | string |
ID da função |
|
|
Nome
|
name | string |
Nome |
|
|
Email Id
|
string |
Email Id |
||
|
Telemóvel
|
mobile | string |
Telemóvel |
|
|
Autenticação de SMS
|
sms_auth | string |
Autenticação de SMS |
|
|
Tipo de destinatário
|
type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
|
Message
|
message | string |
Message |
|
|
senha
|
password | string | ||
|
Abafado?
|
muted | boolean |
Isso impedirá Annature de enviar qualquer correspondência ao destinatário |
|
|
Ordem de Assinatura
|
order | integer |
Ordem de Assinatura |
|
|
ID do campo (do modelo)
|
id | True | string |
ID do campo de modelo |
|
Value
|
value | True | string |
Valor para este campo |
|
Ponto de extremidade de destino após o destinatário concluir o envelope
|
session_completed | string |
Ponto de extremidade de destino após o destinatário concluir 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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
compartilhado
|
shared | boolean |
É compartilhado? |
|
rascunho
|
draft | boolean | |
|
account_id
|
account_id | string |
ID da conta |
|
group_id
|
group_id | string |
ID do grupo |
|
Documentos
|
documents | array of object | |
|
ID
|
documents.id | string |
ID |
|
Nome
|
documents.name | string |
Nome |
|
Páginas
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Senhor
|
documents.master | string |
Senhor |
|
Criado
|
documents.created | string |
Criado |
|
destinatários
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
nome
|
recipients.name | string | |
|
email
|
recipients.email | string | |
|
móvel
|
recipients.mobile | string | |
|
mensagem
|
recipients.message | string | |
|
senha
|
recipients.password | boolean | |
|
abafado
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Envelope Nulo
Enviar Envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Enviar Envelope
Enviar Envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Excluir Envelope
Excluir Envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
Obter Campo
Obter Campo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
ID do campo
|
id | True | string |
ID do campo |
Retornos
| Nome | 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 |
|
value
|
value | string |
O valor do campo |
|
Verificado
|
checked | boolean |
Verificado |
|
height
|
height | integer | |
|
largura
|
width | integer | |
|
opções
|
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 |
|
criadas
|
created | string |
Criado |
Obter Campos
Listar todos os campos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
Retornos
| Nome | 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 |
|
value
|
value | string | |
|
Verificado
|
checked | boolean |
Verificado |
|
height
|
height | integer | |
|
largura
|
width | integer | |
|
opções
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
criadas
|
created | string |
Obter contas
Listar todas as contas
Retornos
| Nome | 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 | |
|
ativo
|
active | boolean | |
|
group_id
|
group_id | string | |
|
criadas
|
created | string | |
|
verificado
|
verified | string |
Obter Destinatário
Obter um único destinatário criado para um envelope usando a propriedade ID que foi retornada no corpo da resposta criar um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
ID do destinatário |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
email
|
string |
|
|
|
móvel
|
mobile | string |
Telemóvel |
|
tipo
|
type | string |
Tipo |
|
status
|
status | string |
Situação |
|
mensagem
|
message | string |
Message |
|
Senha
|
password |
Senha |
|
|
Abafado
|
muted | boolean |
Abafado |
|
ordem
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
criadas
|
created | string |
Criado |
|
enviado
|
sent | string |
Sent |
|
recusado
|
declined | string |
Recusado |
|
concluído
|
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 para um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
Duração do ponto de extremidade
|
endpoint_duration | integer |
Define o número de minutos para os 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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
ID |
|
Nome
|
name | string |
Nome |
|
Páginas
|
pages | integer | |
|
Original
|
original | string |
Original |
|
Senhor
|
master | string |
Senhor |
|
Criado
|
created | string |
Criado |
Obter Envelope
Obter Envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
id | True | string |
Envelope ID |
|
Duração do ponto de extremidade
|
endpoint_duration | integer |
Define o número de minutos para os 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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
status
|
status | string |
Situação |
|
compartilhado
|
shared | boolean |
Compartilhado |
|
criadas
|
created | string |
Criado |
|
enviado
|
sent | string |
Sent |
|
Anulada
|
voided | string |
Anulado |
|
recusado
|
declined | string |
Recusado |
|
concluído
|
completed | string |
Concluído |
|
master
|
master | string |
Senhor |
|
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 |
|
Email Id
|
recipients.email | string |
Email Id |
|
Telemóvel
|
recipients.mobile | string |
Telemóvel |
|
Tipo de destinatário
|
recipients.type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
Message
|
recipients.message | string |
Message |
|
Senha
|
recipients.password | ||
|
Abafado?
|
recipients.muted | boolean |
Isso impedirá Annature de enviar qualquer correspondência ao destinatário |
|
Ordem de Assinatura
|
recipients.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário concluir o envelope
|
recipients.redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário concluir 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 |
|
fields
|
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 | |
|
criadas
|
recipients.fields.created | string |
Obter envelopes
Listar todos os envelopes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do envelope
|
name | string |
Um filtro de correspondência exata na lista com base na propriedade de nome do envelope |
|
|
Envelope Status
|
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 na propriedade de email de qualquer destinatário |
|
|
Criado antes
|
created_before | date |
Retorna resultados em que a data criada está antes do valor fornecido |
|
|
Criado após
|
created_after | date |
Retorna resultados em que a data criada é após o valor fornecido |
|
|
Concluído antes
|
completed_before | date |
Retorna resultados em que a data concluída está antes do valor fornecido |
|
|
Concluído após
|
completed_after | date |
Retorna resultados em que a data concluída é após o valor fornecido |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
mensagem
|
message | string |
Message |
|
status
|
status | string |
Situação |
|
compartilhado
|
shared | boolean |
Compartilhado |
|
criadas
|
created | string |
Criado |
|
enviado
|
sent | string |
Sent |
|
Anulada
|
voided | string |
Anulado |
|
recusado
|
declined | string |
Recusado |
|
concluído
|
completed | string |
Concluído |
|
combinado
|
combined | string |
Combinado |
|
master
|
master | string |
Senhor |
|
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 |
|
Email Id
|
recipients.email | string |
Email Id |
|
Telemóvel
|
recipients.mobile | string |
Telemóvel |
|
Tipo de destinatário
|
recipients.type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
Message
|
recipients.message | string |
Message |
|
Senha
|
recipients.password | ||
|
Abafado?
|
recipients.muted | boolean |
Isso impedirá Annature de enviar qualquer correspondência ao destinatário |
|
Ordem de Assinatura
|
recipients.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário concluir o envelope
|
recipients.redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário concluir 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 |
|
fields
|
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 | |
|
criadas
|
recipients.fields.created | string |
Obter modelo
Obter modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Modelo
|
id | True | string |
ID do Modelo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
Compartilhado
|
shared | boolean |
Compartilhado |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
criadas
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentos
|
documents | array of object | |
|
ID
|
documents.id | string |
ID |
|
Nome
|
documents.name | string |
Nome |
|
Páginas
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Senhor
|
documents.master | string |
Senhor |
|
Criado
|
documents.created | string |
Criado |
|
funções
|
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 |
|
Email do destinatário
|
roles.recipient_email | string |
Email do destinatário |
|
Dispositivo Móvel do Destinatário
|
roles.recipient_mobile | string |
Dispositivo Móvel do Destinatário |
|
Tipo de destinatário
|
roles.recipient_type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
Senha
|
roles.recipient_password | string |
Senha |
|
Ordem de Assinatura
|
roles.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário concluir o envelope
|
roles.recipient_redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário concluir 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | string |
Um filtro de correspondência exata na lista com base nos modelos |
|
|
Criado antes
|
created_before | date |
Retorna resultados em que a data criada está antes do valor fornecido |
|
|
Criado após
|
created_after | date |
Retorna resultados em que a data criada é após o valor fornecido |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
nome
|
name | string | |
|
Compartilhado
|
shared | boolean |
Compartilhado |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
criadas
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documentos
|
documents | array of object | |
|
ID
|
documents.id | string |
ID |
|
Nome
|
documents.name | string |
Nome |
|
Páginas
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Senhor
|
documents.master | string |
Senhor |
|
Criado
|
documents.created | string |
Criado |
|
funções
|
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 |
|
Email do destinatário
|
roles.recipient_email | string |
Email do destinatário |
|
Dispositivo Móvel do Destinatário
|
roles.recipient_mobile | string |
Dispositivo Móvel do Destinatário |
|
Tipo de destinatário
|
roles.recipient_type | string |
O tipo de destinatário, padrão para o signatário quando não fornecido |
|
Senha
|
roles.recipient_password | string |
Senha |
|
Ordem de Assinatura
|
roles.order | integer |
Ordem de Assinatura |
|
Ponto de extremidade de destino após o destinatário concluir o envelope
|
roles.recipient_redirects.session_completed | string |
Ponto de extremidade de destino após o destinatário concluir 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
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID |
|
nome
|
name | string |
Nome |
|
empresa
|
business | string |
Negócios |
|
email
|
string |
|
|
|
número
|
number | string |
Número |
|
address
|
address | string |
Endereço |
|
site
|
website | string |
Site |
|
logotipo
|
logo | string |
Logotipo |
|
cor
|
colour | string |
Cor |
|
criadas
|
created | string |
Criado |
Obter todos os anexos de um campo
Obter anexos de campo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelope_id | True | string |
Envelope ID |
|
ID do campo
|
id | True | string |
ID do campo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Original
|
original | string | |
|
nome
|
name | string | |
|
tipo
|
type | string | |
|
size
|
size | integer | |
|
criadas
|
created | string |
Gatilhos
| Gatilho de Evento – Envelope e Destinatário |
Dispara quando um evento ocorre quando envelopes concluídos ou exibições de destinatário |
Gatilho de Evento – Envelope e Destinatário
Dispara quando um evento ocorre quando envelopes concluídos ou exibições de destinatário
Retornos
- Corpo
- WebhookEventContent
Definições
WebhookEventContent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
evento
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
Anulada
|
voided | string | |
|
concluído
|
completed | string | |
|
master
|
master | string | |
|
certificado
|
certificate | string | |
|
enviado
|
sent | string | |
|
método
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
Visualizaram
|
viewed | string | |
|
recusado
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
falhou
|
failed | string | |
|
Diagnóstico
|
diagnosis | string |