Signhost (versão prévia)
Assinar 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 empresas com transações online perfeitas e seguras.
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 | Equipe de sucesso do cliente signhost |
| URL | https://intercom.help/signhost/en/ |
| support@signhost.com |
| Metadados do conector | |
|---|---|
| Publicador | Signhost |
| Site | https://www.signhost.com |
| Política de privacidade | https://www.evidos.com/privacy |
| Categorias | Conteúdo e arquivos; Produtividade |
SignHost
Assinar 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 empresas com transações online perfeitas e seguras.
Publicador
Entrust Netherlands B.V.
Pré-requisitos
Você precisará de uma assinatura do SignHost para usar esse conector. Você pode gerar uma APIKey no portal signhost
Operações com suporte
Obter detalhes da transação
Retorna detalhes da transação atual. Não use essa ação para sondagem ativa.
Excluir transação
Exclua uma transação por uma ID de transação. Quando uma transação não estiver em um estado final (como totalmente assinada), a transação será cancelada e limpa. Uma transação cancelada pode ser informada para enviar uma notificação por email aos signatários que aguardam que a transação tenha sido cancelada. O status da transação será definido como cancelado. Quando uma transação estiver 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.
Baixar PDF
Retorna o(s) documento (assinado).
Baixar recibo
Retorna o recibo quando a transação é assinada com êxito.
Criar transação
Cria uma nova transação.
Adicionar arquivo
Adicione um arquivo à transação.
Iniciar transação
Inicia uma transação com o mesmo {transactionId}.
Obtendo credenciais
Você pode gerar um usertoken na página de configurações no portal do SignHost. Use o prefixo 'APIKey' na frente do usertoken.
Problemas e limitações conhecidos
Atualmente, nem todos os recursos têm suporte. Damos as boas-vindas a você para entrar em contato conosco com quaisquer solicitações ou investigações.
Instruções de implantação
Siga as instruções em Criar um conector personalizado a partir de uma definição de OpenAPI.
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 |
|---|---|---|---|
| Authorization | secureString | Forneça sua APIKey. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar arquivo |
Adicione um arquivo à transação ou substitua um arquivo existente com o mesmo {fileId}. |
| Baixar pdf |
Retorna o(s) documento (assinado). |
| Baixar recibo |
Retorna o recibo quando a transação é assinada com êxito (Status=30) |
| Criar transação |
Cria uma nova transação |
| Excluir transação |
Excluir uma transação por uma ID de transação |
| Iniciar transação |
Inicia uma transação com o mesmo {transactionId} |
| Obter detalhes da transação |
Retorna detalhes da transação atual |
Adicionar arquivo
Adicione um arquivo à transação ou substitua um arquivo existente com o mesmo {fileId}.
Parâmetros
| Nome | Chave | Obrigató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 |
Upload de arquivos |
Baixar pdf
Retorna o(s) documento (assinado).
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
- Content
- binary
Baixar recibo
Retorna o recibo quando a transação é assinada com êxito (Status=30)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da transação
|
transactionId | True | string |
ID da descrição |
Retornos
- Content
- binary
Criar transação
Cria uma nova transação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivos
|
Files | object |
Um mapa de arquivos anexados a essa transação. |
|
|
Linguagem
|
Language | string |
Idioma, somente de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL são permitidos. |
|
|
Foca
|
Seal | boolean |
Selo o documento antes de enviar para os signatários. |
|
|
ID
|
Id | string |
A ID do signatário deve ser exclusiva em uma transação. |
|
|
Email
|
True | string |
O endereço de email do signatário |
|
|
IntroText
|
IntroText | string |
Um texto de introdução a ser mostrado ao usuário durante o processo de sinal. |
|
|
Tipo
|
Type | True | string |
Tipo do objeto de autenticação. |
|
Número
|
Number | string |
Número de telefone: esse campo é obrigatório quando o método de autenticação PhoneNumber é escolhido |
|
|
Bsn
|
Bsn | number |
Esse 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 sinal para o signatário seu endereço de email. |
|
|
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 email de solicitação de sinal em texto sem formatação. |
|
|
SignRequestMessage
|
SignRequestMessage | string |
A mensagem da solicitação de sinal em texto sem formatação. |
|
|
SendSignConfirmation
|
SendSignConfirmation | boolean |
Envie a confirmação de sinal para o signatário seu endereço de email. |
|
|
Linguagem
|
Language | string |
Idioma, somente 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, ele será preenchido previamente no formulário de rabisco. |
|
|
DaysToRemind
|
DaysToRemind | integer |
Quantidade de dias antes de lembrar os signatários. -1 para desabilitar 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. |
|
|
Referência
|
Reference | string |
A referência do signatário. |
|
|
RejectReason
|
RejectReason | string |
O motivo da 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 após a assinatura, a rejeição ou o cancelamento. |
|
|
Contexto
|
Context | object |
Qualquer objeto json válido que retornaremos. |
|
|
ID
|
Id | string | ||
|
Code
|
Code | integer |
Consultar a documentação da API |
|
|
Informações
|
Info | string |
Pode conter informações adicionais que pertencem a essa atividade |
|
|
CreatedDateTime
|
CreatedDateTime | date-time | ||
|
Nome
|
Name | True | string |
O nome do receptor. |
|
Email
|
True | string |
O endereço de email do receptor. |
|
|
Linguagem
|
Language | string |
Idioma, somente de-DE, en-US, es-ES, fr-FR, it-IT e nl-NL permitidos. |
|
|
Assunto
|
Subject | string |
O assunto do email do receptor em texto sem formatação. |
|
|
Message
|
Message | True | string |
A mensagem de email para o receptor em texto sem formatação. |
|
Referência
|
Reference | string |
A referência do receptor. |
|
|
Contexto
|
Context | object |
Qualquer objeto json válido que retornaremos. |
|
|
Referência
|
Reference | string |
A referência da transação. |
|
|
PostbackUrl
|
PostbackUrl | string |
A URL absoluta para postar as atualizações de status. |
|
|
SignRequestMode
|
SignRequestMode | integer |
Defina como 1 para envio de uma vez, para 2 para sequencial. |
|
|
DaysToExpire
|
DaysToExpire | integer |
Quantidade de dias antes da expiração. Máximo de 90 dias. |
Retornos
- Corpo
- Transaction
Excluir transação
Excluir uma transação por uma ID de transação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da transação
|
transactionId | True | string |
ID da transação |
|
SendNotifications
|
SendNotifications | boolean |
Envie notificações por email 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
| Nome | Chave | Obrigató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
Retorna detalhes da transação atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da transação
|
transactionId | True | string |
ID da transação |
Retornos
- Corpo
- Transaction
Definições
Transação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
Id | string |
A ID da transação. |
|
Arquivos
|
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 | |
|
DisplayName
|
Files.DisplayName | string | |
|
Linguagem
|
Language | string |
O idioma, somente de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL permitidos. |
|
Foca
|
Seal | boolean |
Selo o documento antes de enviar para os signatários. |
|
Signatários
|
Signers | array of object |
As informações do signatário. |
|
ID
|
Signers.Id | string |
A ID do signatário deve ser exclusiva em uma transação. |
|
Email
|
Signers.Email | string |
O endereço de email do signatário |
|
IntroText
|
Signers.IntroText | string |
Um texto de introdução a ser mostrado ao usuário durante o processo de sinal. |
|
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 precisa verificar. |
|
SendSignRequest
|
Signers.SendSignRequest | boolean |
Envie um convite de sinal para o signatário seu endereço de email. |
|
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 email de solicitação de sinal em texto sem formatação. |
|
SignRequestMessage
|
Signers.SignRequestMessage | string |
A mensagem da solicitação de sinal em texto sem formatação. |
|
SendSignConfirmation
|
Signers.SendSignConfirmation | boolean |
Envie a confirmação de sinal para o signatário seu endereço de email. |
|
Linguagem
|
Signers.Language | string |
Somente de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL e nl-NL são permitidos. |
|
ScribbleName
|
Signers.ScribbleName | string |
O nome do signatário, ele será preenchido previamente 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. |
|
Referência
|
Signers.Reference | string |
A referência do signatário. |
|
RejectReason
|
Signers.RejectReason | string |
O motivo da 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 após a assinatura, a rejeição ou o cancelamento. |
|
Contexto
|
Signers.Context | object |
Qualquer objeto json válido que retornaremos. |
|
Activities
|
Signers.Activities | array of object |
Lista de atividades anexadas a este signatário. |
|
ID
|
Signers.Activities.Id | string | |
|
Code
|
Signers.Activities.Code | integer |
|
|
Informações
|
Signers.Activities.Info | string |
Pode conter informações adicionais que pertencem a essa atividade |
|
CreatedDateTime
|
Signers.Activities.CreatedDateTime | date-time | |
|
Receptores
|
Receivers | array of object | |
|
Nome
|
Receivers.Name | string |
O nome do receptor. |
|
Email
|
Receivers.Email | string |
O endereço de email do receptor. |
|
Linguagem
|
Receivers.Language | string |
O idioma do receptor, somente de-DE, en-US, es-ES, fr-FR, it-IT e nl-NL são permitidos. |
|
Assunto
|
Receivers.Subject | string |
O assunto do email do receptor em texto sem formatação. |
|
Message
|
Receivers.Message | string |
A mensagem de email para o receptor em texto sem formatação. |
|
Referência
|
Receivers.Reference | string |
A referência do receptor. |
|
Contexto
|
Receivers.Context | object |
Qualquer objeto json válido que retornaremos. |
|
Referência
|
Reference | string |
A referência da transação. Por exemplo, "1234" |
|
PostbackUrl
|
PostbackUrl | string |
A URL absoluta para postar as atualizações de status. |
|
SignRequestMode
|
SignRequestMode | integer |
Defina como 1 para envio de uma vez, para 2 para sequencial. |
|
DaysToExpire
|
DaysToExpire | integer |
Quantidade de dias antes da expiração. Máximo de 90 dias. |
|
SendEmailNotifications
|
SendEmailNotifications | boolean |
Envie notificações por email ao remetente. |
|
Situação
|
Status | integer |
Status da transação atual. |
|
CancelationReason
|
CancelationReason | string |
O motivo original do cancelamento dado durante uma chamada DELETE. |
|
Contexto
|
Context | object |
Qualquer objeto json válido que retornaremos. |
Authentication
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | string |
Tipo do objeto de autenticação. |
|
Número
|
Number | string |
Número de telefone: esse campo é obrigatório quando o método de autenticação PhoneNumber é escolhido |
|
Bsn
|
Bsn | number |
Esse campo é obrigatório quando o método de autenticação BSN é escolhido |
Verificação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
Type | string |
Tipo do objeto de verificação. |
binário
Esse é o tipo de dados básico 'binary'.