Signhost (Pré-visualização)
Signhost o serviço de assinatura de fluxo de trabalho da Entrust é uma solução de assinatura e identificação digital, capacitando todos os tipos de negócios com transações on-line contínuas e seguras.
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 | Equipe de sucesso do cliente Signhost |
| URL | https://intercom.help/signhost/en/ |
| support@signhost.com |
| Metadados do conector | |
|---|---|
| Editora | Signhost |
| Sítio Web | https://www.signhost.com |
| Política de privacidade | https://www.evidos.com/privacy |
| Categorias | Conteúdos e Ficheiros; Produtividade |
SignHost
Signhost o serviço de assinatura de fluxo de trabalho da Entrust é uma solução de assinatura e identificação digital, capacitando todos os tipos de negócios com transações on-line contínuas e seguras.
Editora
Entrust Países Baixos B.V.
Pré-requisitos
Você precisará de uma assinatura SignHost para usar esse conector. Você pode gerar um APIKey a partir do portal Signhost
Operações suportadas
Obter detalhes da transação
Retorna os detalhes atuais da transação. Por favor, não use esta ação para sondagem ativa.
Excluir transação
Exclua uma transação por uma ID de transação. Quando uma transação não está em um estado final (como totalmente assinada), a transação será cancelada e limpa. Uma transação cancelada pode ser instruída a enviar uma notificação por e-mail aos signatários que aguardam que a transação foi cancelada. O status da transação será definido como cancelado. Quando uma transação está em um estado final, a transação será limpa. O status da transação permanecerá o mesmo, mas limparemos todos os documentos carregados e dados confidenciais o mais rápido possível.
Transferir PDF
Devolve o(s) documento(s) (assinado(s).
Recibo de download
Devolve o recibo quando a transação é assinada com êxito.
Criar transação
Cria uma nova transação.
Adicionar ficheiro
Adicione um arquivo à transação.
Iniciar transação
Inicia uma transação com o mesmo {transactionId}.
Obtenção de credenciais
Você pode gerar um usertoken na página de configurações no portal SignHost. Por favor, certifique-se de usar o prefixo 'APIKey ' na frente do seu usertoken.
Problemas conhecidos e limitações
Atualmente, nem todos os recursos são suportados. Convidamo-lo a contactar-nos com quaisquer pedidos ou perguntas.
Instruções de implantação
Siga as instruções em Criar um conector personalizado a partir de uma definição OpenAPI.
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 |
|---|---|---|---|
| Authorization | securestring | Forneça sua APIKey. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar ficheiro |
Adicione um arquivo à transação ou substitua um arquivo existente pelo mesmo {fileId}. |
| Criar transação |
Cria uma nova transação |
| Descarregar pdf |
Devolve o(s) documento(s) (assinado(s). |
| Excluir transação |
Excluir uma transação por um ID de transação |
| Iniciar transação |
Inicia uma transação com o mesmo {transactionId} |
| Obter detalhes da transação |
Devolve os detalhes atuais da transação |
| Recibo de download |
Devolve o recibo quando a transação é assinada com êxito (Status=30) |
Adicionar ficheiro
Adicione um arquivo à transação ou substitua um arquivo existente pelo mesmo {fileId}.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID de uma transação existente - ainda não iniciada - |
|
ID do arquivo
|
fileId | True | string |
Um identificador exclusivo fornecido por você para o arquivo. |
|
Binário de arquivo
|
body | True | binary |
Carregamento de ficheiro |
Criar transação
Cria uma nova transação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ficheiros
|
Files | object |
Um mapa de arquivos anexados a esta transação. |
|
|
Linguagem
|
Language | string |
Idioma, apenas de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL são permitidos. |
|
|
Selo
|
Seal | boolean |
Sela o documento antes de enviar aos signatários. |
|
|
Id
|
Id | string |
O id do signatário deve ser exclusivo dentro de uma transação. |
|
|
Email
|
True | string |
O endereço de e-mail do signatário |
|
|
Introtexto
|
IntroText | string |
Um texto de introdução para mostrar ao usuário durante o processo de assinatura. |
|
|
Tipo
|
Type | True | string |
Tipo do objeto de autenticação. |
|
Número
|
Number | string |
Número de telefone: Este campo é obrigatório quando o método de autenticação PhoneNumber é escolhido |
|
|
Bsn
|
Bsn | number |
Este campo é obrigatório quando o método de autenticação BSN é escolhido |
|
|
Tipo
|
Type | True | string |
Tipo do objeto de verificação. |
|
SendSignRequest
|
SendSignRequest | boolean |
Envie um convite de assinatura para o signatário seu endereço de e-mail. |
|
|
SignUrl
|
SignUrl | string |
Uma URL exclusiva por signatário que fornece o fluxo de assinatura para o signatário. |
|
|
SignRequestSubject
|
SignRequestSubject | string |
O assunto do e-mail de solicitação de assinatura em texto simples. |
|
|
SignRequestMessage
|
SignRequestMessage | string |
A mensagem do pedido de assinatura em texto simples. |
|
|
SendSignConfirmation
|
SendSignConfirmation | boolean |
Envie a confirmação de assinatura para o signatário seu endereço de e-mail. |
|
|
Linguagem
|
Language | string |
Idioma, apenas de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL são permitidos. |
|
|
ScribbleName
|
ScribbleName | string |
O nome do signatário, este será pré preenchido no formulário de rabisco. |
|
|
DaysToRemind
|
DaysToRemind | integer |
Quantidade de dias antes de lembrar os signatários. -1 para desativar lembretes. |
|
|
Expira
|
Expires | date-time |
Quando definido, o signatário não tem mais permissão para assinar a transação após essa data. |
|
|
Reference
|
Reference | string |
A referência do signatário. |
|
|
RejectReason
|
RejectReason | string |
O motivo de rejeição que foi dado pelo signatário quando a transação foi rejeitada. |
|
|
ReturnUrl
|
ReturnUrl | string |
A url para a qual redirecionar o usuário depois de assinar, rejeitar ou cancelar. |
|
|
Context
|
Context | object |
Qualquer objeto json válido que retornaremos. |
|
|
Id
|
Id | string | ||
|
Código
|
Code | integer |
Consulte a documentação da api |
|
|
Informações
|
Info | string |
Pode conter informações adicionais pertencentes a esta atividade |
|
|
CreatedDateTime
|
CreatedDateTime | date-time | ||
|
Nome
|
Name | True | string |
O nome do recetor. |
|
Email
|
True | string |
O endereço de e-mail do destinatário. |
|
|
Linguagem
|
Language | string |
Idioma, apenas de-DE, en-US, es-ES, fr-FR, it-IT e nl-NL permitidos. |
|
|
Assunto
|
Subject | string |
O assunto do e-mail do destinatário em texto simples. |
|
|
Message
|
Message | True | string |
A mensagem de e-mail para o destinatário em texto simples. |
|
Reference
|
Reference | string |
A referência do recetor. |
|
|
Context
|
Context | object |
Qualquer objeto json válido que retornaremos. |
|
|
Reference
|
Reference | string |
A referência da transação. |
|
|
PostbackUrl
|
PostbackUrl | string |
O url absoluto para postback as atualizações de status. |
|
|
SignRequestMode
|
SignRequestMode | integer |
Defina como 1 para envio de uma só vez, para 2 para sequencial. |
|
|
DiasToExpirar
|
DaysToExpire | integer |
Quantidade de dias antes do vencimento. Máximo 90 dias. |
Devoluções
- Body
- Transaction
Descarregar pdf
Devolve o(s) documento(s) (assinado(s).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID da descrição |
|
Nome
|
fileId | True | string |
Um identificador exclusivo fornecido por você para o arquivo. |
Devoluções
- Content
- binary
Excluir transação
Excluir uma transação por um ID de transação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID da transação |
|
EnviarNotificações
|
SendNotifications | boolean |
Envie notificações por e-mail para os signatários que aguardam. |
|
|
Reason
|
Reason | string |
O motivo do cancelamento. |
Iniciar transação
Inicia uma transação com o mesmo {transactionId}
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID de uma transação existente - ainda não iniciada - |
Obter detalhes da transação
Devolve os detalhes atuais da transação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID da transação |
Devoluções
- Body
- Transaction
Recibo de download
Devolve o recibo quando a transação é assinada com êxito (Status=30)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
ID da descrição |
Devoluções
- Content
- binary
Definições
Transação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
Id | string |
O id da transação. |
|
Ficheiros
|
Files | array of object | |
|
Links
|
Files.Links | array of object | |
|
Rel
|
Files.Links.Rel | string | |
|
Tipo
|
Files.Links.Type | string | |
|
Link
|
Files.Links.Link | string | |
|
Nome de Exibição
|
Files.DisplayName | string | |
|
Linguagem
|
Language | string |
O idioma, apenas de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL permitidos. |
|
Selo
|
Seal | boolean |
Sela o documento antes de enviar aos signatários. |
|
Signatários
|
Signers | array of object |
As informações do signatário. |
|
Id
|
Signers.Id | string |
O id do signatário deve ser exclusivo dentro de uma transação. |
|
Email
|
Signers.Email | string |
O endereço de e-mail do signatário |
|
Introtexto
|
Signers.IntroText | string |
Um texto de introdução para mostrar ao usuário durante o processo de assinatura. |
|
Autenticações
|
Signers.Authentications | array of Authentication |
Lista de autenticações com as quais o signatário precisa se autenticar. |
|
Verificações
|
Signers.Verifications | array of Verification |
Lista de verificações com as quais o signatário deve verificar. |
|
SendSignRequest
|
Signers.SendSignRequest | boolean |
Envie um convite de assinatura para o signatário seu endereço de e-mail. |
|
SignUrl
|
Signers.SignUrl | string |
Uma URL exclusiva por signatário que fornece o fluxo de assinatura para o signatário. |
|
SignRequestSubject
|
Signers.SignRequestSubject | string |
O assunto do e-mail de solicitação de assinatura em texto simples. |
|
SignRequestMessage
|
Signers.SignRequestMessage | string |
A mensagem do pedido de assinatura em texto simples. |
|
SendSignConfirmation
|
Signers.SendSignConfirmation | boolean |
Envie a confirmação de assinatura para o signatário seu endereço de e-mail. |
|
Linguagem
|
Signers.Language | string |
Só são permitidos de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL. |
|
ScribbleName
|
Signers.ScribbleName | string |
O nome do signatário, este será pré preenchido no formulário de rabisco. |
|
DaysToRemind
|
Signers.DaysToRemind | integer |
Quantidade de dias antes de lembrar os signatários. |
|
Expira
|
Signers.Expires | date-time |
Quando definido, o signatário não tem mais permissão para assinar a transação após essa data. |
|
Reference
|
Signers.Reference | string |
A referência do signatário. |
|
RejectReason
|
Signers.RejectReason | string |
O motivo de rejeição que foi dado pelo signatário quando a transação foi rejeitada. |
|
ReturnUrl
|
Signers.ReturnUrl | string |
A url para a qual redirecionar o usuário depois de assinar, rejeitar ou cancelar. |
|
Context
|
Signers.Context | object |
Qualquer objeto json válido que retornaremos. |
|
Activities
|
Signers.Activities | array of object |
Lista de atividades anexa a este signatário. |
|
Id
|
Signers.Activities.Id | string | |
|
Código
|
Signers.Activities.Code | integer |
|
|
Informações
|
Signers.Activities.Info | string |
Pode conter informações adicionais pertencentes a esta atividade |
|
CreatedDateTime
|
Signers.Activities.CreatedDateTime | date-time | |
|
Recetores
|
Receivers | array of object | |
|
Nome
|
Receivers.Name | string |
O nome do recetor. |
|
Email
|
Receivers.Email | string |
O endereço de e-mail do destinatário. |
|
Linguagem
|
Receivers.Language | string |
A língua do recetor, apenas de-DE, en-US, es-ES, fr-FR, it-IT e nl-NL são permitidos. |
|
Assunto
|
Receivers.Subject | string |
O assunto do e-mail do destinatário em texto simples. |
|
Message
|
Receivers.Message | string |
A mensagem de e-mail para o destinatário em texto simples. |
|
Reference
|
Receivers.Reference | string |
A referência do recetor. |
|
Context
|
Receivers.Context | object |
Qualquer objeto json válido que retornaremos. |
|
Reference
|
Reference | string |
A referência da transação. Por exemplo, "1234" |
|
PostbackUrl
|
PostbackUrl | string |
O url absoluto para postback as atualizações de status. |
|
SignRequestMode
|
SignRequestMode | integer |
Defina como 1 para envio de uma só vez, para 2 para sequencial. |
|
DiasToExpirar
|
DaysToExpire | integer |
Quantidade de dias antes do vencimento. Máximo 90 dias. |
|
SendEmailNotifications
|
SendEmailNotifications | boolean |
Envie notificações por e-mail para o remetente. |
|
Situação
|
Status | integer |
Status atual da transação. |
|
CancelamentoMotivo
|
CancelationReason | string |
O motivo original do cancelamento dado durante uma chamada DELETE. |
|
Context
|
Context | object |
Qualquer objeto json válido que retornaremos. |
Authentication
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | string |
Tipo do objeto de autenticação. |
|
Número
|
Number | string |
Número de telefone: Este campo é obrigatório quando o método de autenticação PhoneNumber é escolhido |
|
Bsn
|
Bsn | number |
Este campo é obrigatório quando o método de autenticação BSN é escolhido |
Verification
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | string |
Tipo do objeto de verificação. |
binário
Este é o tipo de dados básico 'binário'.