SigningHub (Pré-visualização)
O SigningHub é uma solução completa para fluxos de trabalho de aprovação de documentos, assinaturas digitais avançadas e acompanhamento de status de documentos. Ele foi projetado para otimizar rapidamente a maneira como as empresas entregam, revisam, aprovam e assinam seus documentos comerciais
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 | |
|---|---|
| support@ascertia.com |
| Metadados do conector | |
|---|---|
| Editora | Ascertia |
| Sítio Web | https://www.signinghub.com |
| Política de privacidade | https://www.signinghub.com/privacy-policy/ |
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.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar destinatário |
Adicionar um destinatário ao fluxo de trabalho existente |
| Aplicar modelo |
Aplicar um modelo fornecido no fluxo de trabalho do documento |
| Aprovar um documento |
O destinatário pode aprovar o fluxo de trabalho neste turno |
| Assinar documento |
Assina um documento por usuário conectado |
| Baixar todos os documentos de um fluxo de trabalho |
Baixe todos os documentos em formato extraído/compactado de um fluxo de trabalho existente do SigningHub |
| Baixar um documento específico de um fluxo de trabalho |
Baixar um documento específico de um fluxo de trabalho existente |
| Carregar um documento no fluxo de trabalho |
Carregar um documento no fluxo de trabalho existente |
| Concluir o fluxo de trabalho (Encerrar no meio) |
O proprietário do fluxo de trabalho pode concluir o fluxo de trabalho em qualquer estágio para encerrá-lo |
| Criar um fluxo de trabalho |
Criar um novo fluxo de trabalho dentro do SigningHub |
| Excluir destinatário de um fluxo de trabalho |
Excluir um destinatário específico de um fluxo de trabalho existente |
| Excluir um fluxo de trabalho |
Excluir fluxo de trabalho existente pelo proprietário do fluxo de trabalho |
| Obter contects |
Obter uma lista de contatos relacionados ao usuário conectado do SigningHub |
| Obter destinatários |
Obter uma lista de destinatários de um fluxo de trabalho existente |
| Obter detalhes do fluxo de trabalho |
Obter os detalhes do fluxo de trabalho |
| Obter fluxos de trabalho |
Obter uma lista de fluxos de trabalho do SigningHub para o usuário conectado |
| Obter modelos |
Obtenha uma lista de todos os modelos empresariais do SigningHub |
| Partilhar um fluxo de trabalho de documentos |
Compartilhar um fluxo de trabalho de documento com o destinatário |
| Recusar um documento |
O destinatário pode recusar o fluxo de trabalho por sua vez |
|
Sobre o Signing |
Obter os detalhes da instância do SigningHub |
Adicionar destinatário
Adicionar um destinatário ao fluxo de trabalho existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho existente |
|
Adicionar campo de assinatura
|
addSignatureField | True | boolean |
Adicionar um campo de assinatura ao fluxo de trabalho |
|
ID do documento
|
documentId | integer |
O ID do documento |
|
|
Notificação por e-mail
|
emailNotification | True | boolean |
Notificação por e-mail |
|
Só eu
|
onlyMe | boolean |
O tipo de destinatário como apenas eu |
|
|
N.º da página
|
pageNo | integer |
O número da página do documento |
|
|
Posição da página
|
pagePosition | True | string |
a posição na página |
|
Página X
|
pageX | integer |
A posição horizontal na página do documento |
|
|
Página Y
|
pageY | integer |
A posição vertical na página do documento |
|
|
Funções
|
role | True | string |
O papel do destinatário |
|
Ordem de assinatura
|
signingOrder | True | integer |
A ordem da assinatura do destinatário |
|
E-mail do usuário
|
userEmail | True | string |
O e-mail do destinatário |
|
Nome de utilizador
|
userName | True | string |
O nome do destinatário |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Destinatário adicionado
|
recipientAdded | boolean |
Resposta adicionada pelo destinatário |
Aplicar modelo
Aplicar um modelo fornecido no fluxo de trabalho do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
ID do documento
|
documentId | True | integer |
O ID do documento |
|
Aplicável a todos
|
applyToAll | True | boolean |
Aplicar a todos os documentos |
|
Nome do modelo
|
templateName | True | string |
O nome do modelo aplicado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Certificar ativado
|
applyTemplate.certify.enabled | boolean |
O valor habilitado para certificação |
|
Certificar permissão
|
applyTemplate.certify.permission | string |
O valor de permissão de certificação |
|
Altura do documento
|
applyTemplate.document_height | integer |
A altura do documento |
|
ID do documento
|
applyTemplate.document_id | integer |
O ID do documento |
|
Nome do documento
|
applyTemplate.document_name | string |
O nome do documento |
|
Ordem de documentos
|
applyTemplate.document_order | integer |
A ordem do documento no fluxo de trabalho |
|
Páginas do documento
|
applyTemplate.document_pages | integer |
Total de páginas do documento |
|
Fonte do documento
|
applyTemplate.document_source | string |
A fonte do documento |
|
Tipo de documento
|
applyTemplate.document_type | string |
O tipo de documento |
|
Largura do documento
|
applyTemplate.document_width | integer |
A largura do documento |
|
Campos de formulário
|
applyTemplate.form_fields | boolean |
A disponibilidade dos campos de formulário no documento |
|
Bloquear campos de formulário
|
applyTemplate.lock_form_fields | boolean |
O valor ativado dos campos de formulário de bloqueio |
|
Modificada em
|
applyTemplate.modified_on | string |
A data da modificação |
|
Somente leitura
|
applyTemplate.template.read_only | boolean |
O tipo somente pronto do modelo |
|
Nome do modelo
|
applyTemplate.template.template_name | string |
O nome do modelo aplicado |
|
Carregado em
|
applyTemplate.uploaded_on | string |
A data do carregado em |
Aprovar um documento
O destinatário pode aprovar o fluxo de trabalho neste turno
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
Razão de aprovação
|
approveReason | string |
O motivo para aprovar o documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documento aprovado
|
documentApproved | boolean |
O estado do documento aprovado |
Assinar documento
Assina um documento por usuário conectado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
ID do documento
|
documentId | True | integer |
O ID do documento |
|
N.º da página
|
pageNo | True | integer |
O número da página do documento |
|
Posição da página
|
pagePosition | True | string |
A posição na página do documento |
|
Página X
|
pageX | integer |
A posição horizontal na página do documento |
|
|
Página Y
|
pageY | integer |
A posição vertical na página do documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do documento
|
documentName | string |
O nome do documento assinado |
|
Nome do campo
|
fieldName | string |
O nome do campo assinado |
|
Situação
|
status | string |
O status do documento assinado |
Baixar todos os documentos de um fluxo de trabalho
Baixe todos os documentos em formato extraído/compactado de um fluxo de trabalho existente do SigningHub
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Conteúdo do fluxo de trabalho
|
packageContent | byte |
O conteúdo do fluxo de trabalho na cadeia de caracteres base64 |
|
Tipo de fluxo de trabalho
|
packageType | string |
O tipo de conteúdo do fluxo de trabalho |
Baixar um documento específico de um fluxo de trabalho
Baixar um documento específico de um fluxo de trabalho existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
ID do documento
|
documentId | True | integer |
O ID do documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Conteúdo do documento
|
documentContent | byte |
O conteúdo do documento na cadeia de caracteres base64 |
|
Tipo de documento
|
documentType | string |
O tipo de documento |
Carregar um documento no fluxo de trabalho
Carregar um documento no fluxo de trabalho existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho existente |
|
Conteúdo do documento
|
documentContent | True | byte |
O conteúdo do documento adicionado na base64 |
|
Nome do documento com extensão
|
documentName | True | string |
O nome do documento adicionado com extensão |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
documentId | string |
O ID do documento carregado |
Concluir o fluxo de trabalho (Encerrar no meio)
O proprietário do fluxo de trabalho pode concluir o fluxo de trabalho em qualquer estágio para encerrá-lo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | string |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Fluxo de trabalho concluído
|
workflowCompleted | boolean |
O status do fluxo de trabalho concluído |
Criar um fluxo de trabalho
Criar um novo fluxo de trabalho dentro do SigningHub
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do documento
|
documentContent | True | string |
Conteúdo do documento na base64 |
|
Nome do fluxo de trabalho
|
documentName | True | string |
Criar um novo fluxo de trabalho dentro do SigningHub |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
documentId | integer |
O ID do documento |
|
ID do pacote
|
packageId | integer |
A ID do fluxo de trabalho |
Excluir destinatário de um fluxo de trabalho
Excluir um destinatário específico de um fluxo de trabalho existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
Encomenda
|
order | True | integer |
A ordem do destinatário excluído |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Destinatário excluído
|
recipientDeleted | boolean |
O status excluído do destinatário |
Excluir um fluxo de trabalho
Excluir fluxo de trabalho existente pelo proprietário do fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Fluxo de trabalho excluído
|
packageDeleted | boolean |
A resposta excluída do fluxo de trabalho |
Obter contects
Obter uma lista de contatos relacionados ao usuário conectado do SigningHub
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Enterprise
|
enterprise | boolean |
A lista de contactos da empresa |
|
|
N.º da página
|
pageNo | True | integer |
O número da página |
|
Registos por página
|
recordsPerPage | True | integer |
O número de registos por página |
|
Pesquisar texto
|
searchText | string |
O texto de pesquisa para filtrar a lista |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
E-mail do usuário
|
user_email | string |
O e-mail do usuário |
|
Nome de utilizador
|
user_name | string |
O nome do usuário |
|
ID nacional do utilizador
|
user_national_id | string |
O ID nacional do utilizador |
Obter destinatários
Obter uma lista de destinatários de um fluxo de trabalho existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
recipients
|
recipients | array of object |
recipients |
|
Delegar
|
recipients.delegatee | string |
O e-mail do delegado |
|
Nome do delegado
|
recipients.delegatee_name | string |
O nome do delegado |
|
Nome do grupo
|
recipients.group_name | string |
O nome do grupo |
|
Encomenda
|
recipients.order | integer |
A ordem do destinatário |
|
Placeholder
|
recipients.placeholder | string |
O valor do espaço reservado |
|
Estado do processo
|
recipients.process_status | string |
O status do espaço reservado |
|
Processado como
|
recipients.processed_as | string |
O processado como valor |
|
Processado por
|
recipients.processed_by | string |
O e-mail do processado por |
|
Processado em
|
recipients.processed_on | string |
A data do tratamento |
|
Reason
|
recipients.reason | string |
O motivo, se houver |
|
Funções
|
recipients.role | string |
O papel do destinatário |
|
Ordem de assinatura
|
recipients.signing_order | integer |
A ordem da assinatura |
|
E-mail do usuário
|
recipients.user_email | string |
O e-mail do usuário |
|
Nome de utilizador
|
recipients.user_name | string |
O nome do usuário |
|
ID nacional do utilizador
|
recipients.user_national_id | string |
O ID nacional do utilizador |
Obter detalhes do fluxo de trabalho
Obter os detalhes do fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Documentação
|
documents | array of object |
Documentação |
|
allowed_permissions
|
documents.certify.allowed_permissions | array of string |
allowed_permissions |
|
default_permission
|
documents.certify.default_permission | string |
default_permission |
|
enabled
|
documents.certify.enabled | boolean |
enabled |
|
created_on
|
documents.created_on | string |
created_on |
|
document_height
|
documents.document_height | integer |
document_height |
|
document_id
|
documents.document_id | integer |
document_id |
|
document_name
|
documents.document_name | string |
document_name |
|
document_order
|
documents.document_order | integer |
document_order |
|
document_pages
|
documents.document_pages | integer |
document_pages |
|
document_source
|
documents.document_source | string |
document_source |
|
document_type
|
documents.document_type | string |
document_type |
|
document_width
|
documents.document_width | integer |
document_width |
|
form_fields
|
documents.form_fields | boolean |
form_fields |
|
lock_form_fields
|
documents.lock_form_fields | boolean |
lock_form_fields |
|
modified_on
|
documents.modified_on | string |
modified_on |
|
modelo
|
documents.template | string |
modelo |
|
Folder
|
folder | string |
O tipo de pasta |
|
Modificada em
|
modified_on | string |
A data de modificação |
|
Próximo signatário
|
next_signer | string |
O e-mail do próximo signatário |
|
next_signer_email
|
next_signer_email | array of |
next_signer_email |
|
Nome do proprietário
|
owner_name | string |
O nome de exibição do proprietário |
|
ID do fluxo de trabalho
|
package_id | integer |
A ID do fluxo de trabalho |
|
Nome do fluxo de trabalho
|
package_name | string |
O nome do fluxo de trabalho |
|
Proprietário do fluxo de trabalho
|
package_owner | string |
O proprietário do fluxo de trabalho |
|
Status do pacote
|
package_status | string |
O status atual do fluxo de trabalho |
|
Carregado em
|
uploaded_on | string |
A data do fluxo de trabalho carregado |
|
users
|
users | array of |
users |
|
Continuar em declínio
|
workflow.continue_on_decline | boolean |
Continuar em declínio do fluxo de trabalho |
|
contacts
|
workflow.post_process.contacts | array of |
contacts |
|
Dropbox
|
workflow.post_process.dropbox | boolean |
O valor ativado do Dropbox |
|
Unidade do Google
|
workflow.post_process.google_drive | boolean |
O valor ativado da unidade do Google |
|
Destinatários do fluxo de trabalho
|
workflow.post_process.workflow_recipients | boolean |
O valor dos destinatários do fluxo de trabalho |
|
Somente leitura
|
workflow.read_only | boolean |
O valor somente leitura do fluxo de trabalho |
|
Modo de fluxo de trabalho
|
workflow.workflow_mode | string |
O modo do fluxo de trabalho |
|
estado do fluxo de trabalho
|
workflow.workflow_status | string |
O status do fluxo de trabalho |
|
Tipo de fluxo de trabalho
|
workflow.workflow_type | string |
O tipo de fluxo de trabalho |
Obter fluxos de trabalho
Obter uma lista de fluxos de trabalho do SigningHub para o usuário conectado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Estado do documento
|
documentStatus | True | string |
O estado do documento |
|
Folder
|
folder | True | string |
A pasta do fluxo de trabalho do usuário |
|
N.º da página
|
pageNo | True | integer |
O número da página do documento |
|
Registos por página
|
recordsPerPage | integer |
O número de registos por página |
|
|
Pesquisar texto
|
searchText | string |
O texto da pesquisa para filtrar a lista |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
Folder
|
folder | string |
A pasta do fluxo de trabalho do usuário |
|
Modificada em
|
modified_on | string |
A data da modificação |
|
Próximo signatário
|
next_signer | string |
O próximo signatário do fluxo de trabalho |
|
next_signer_email
|
next_signer_email | array of object |
next_signer_email |
|
user_email
|
next_signer_email.user_email | string |
user_email |
|
user_name
|
next_signer_email.user_name | string |
user_name |
|
Nome do proprietário
|
owner_name | string |
O nome do proprietário do fluxo de trabalho |
|
ID do fluxo de trabalho
|
package_id | integer |
A ID do fluxo de trabalho |
|
Nome do fluxo de trabalho
|
package_name | string |
O nome do fluxo de trabalho |
|
Proprietário do fluxo de trabalho
|
package_owner | string |
O e-mail do proprietário do fluxo de trabalho |
|
estado do fluxo de trabalho
|
package_status | string |
O status do fluxo de trabalho |
|
Não lido
|
unread | boolean |
Tipo não lido |
|
Carregado em
|
uploaded_on | string |
A data do fluxo de trabalho carregado |
Obter modelos
Obtenha uma lista de todos os modelos empresariais do SigningHub
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
templatesCollection
|
templatesCollection | array of object |
templatesCollection |
|
|
templatesCollection.read_only | boolean |
read_only |
|
template_id
|
templatesCollection.template_id | integer |
template_id |
|
template_name
|
templatesCollection.template_name | string |
template_name |
|
template_public
|
templatesCollection.template_public | boolean |
template_public |
Partilhar um fluxo de trabalho de documentos
Compartilhar um fluxo de trabalho de documento com o destinatário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID do fluxo de trabalho
|
packageID | integer |
A ID do fluxo de trabalho compartilhado |
Recusar um documento
O destinatário pode recusar o fluxo de trabalho por sua vez
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
packageId | True | integer |
A ID do fluxo de trabalho |
|
Motivo de recusa
|
declineReason | True | string |
O motivo para recusar o documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documento recusado
|
documentDeclined | boolean |
O status do documento declinou |
Sobre o SigningHub
Obter os detalhes da instância do SigningHub
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Construir
|
aboutSigningHub.build | string |
Compilação da instância do SigningHub |
|
Direitos de autor
|
aboutSigningHub.copyright | string |
Direitos autorais do SigningHub |
|
Nome da instalação
|
aboutSigningHub.installation_name | string |
Nome da instalação da instância do SigningHub |
|
N.º de patente dos EUA
|
aboutSigningHub.patents.us_patent_no | string |
N.º de patente dos EUA de SigningHub |
|
Versão
|
aboutSigningHub.version | string |
Versão da instância do SigningHub |