Partilhar via


OláAssinar

O HelloSign permite assinaturas eletrônicas seguras que são de calibre comercial, fáceis de usar e juridicamente vinculativas.

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)
Metadados do conector
Editora Microsoft
Sítio Web https://www.hellosign.com/
Política de privacidade https://www.hellosign.com/privacy

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
Chave da API de administração https://aka.ms/l6zf3z cadeia (de caracteres) A chave de API de uma conta de administrador Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos
Frequência das sondagens de desencadeamento 1 60 segundos

Ações

Cancelar pedido de assinatura

Cancelar uma solicitação de assinatura existente.

Enviar solicitação de assinatura do modelo

Crie e envie uma nova solicitação de assinatura com base em um modelo existente.

Obter pedido de assinatura

Obtenha uma solicitação de assinatura que inclua o status atual de cada signatário.

Cancelar pedido de assinatura

Cancelar uma solicitação de assinatura existente.

Parâmetros

Name Chave Necessário Tipo Description
ID do pedido
requestId True string

O id da solicitação incompleta para cancelar.

Enviar solicitação de assinatura do modelo

Crie e envie uma nova solicitação de assinatura com base em um modelo existente.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de conta
test_mode string

O tipo de conta, Gratuita ou Paga.

ID do modelo
template_id True string

O identificador exclusivo do modelo a partir do qual criar um SignatureRequest.

Assunto
subject string

O assunto no e-mail que será enviado aos signatários.

Message
message string

A mensagem personalizada no e-mail que será enviada aos signatários.

URL de redirecionamento
signing_redirect_url string

A URL para a qual você deseja que o signatário seja redirecionado depois de assinar com êxito.

Permitir Recusa
allow_decline boolean

Permite que os signatários se recusem a assinar um documento se definido como true. É definido para false por padrão.

Signatários
signers True dynamic

Os signatários do documento.

Devoluções

Obter pedido de assinatura

Obtenha uma solicitação de assinatura que inclua o status atual de cada signatário.

Parâmetros

Name Chave Necessário Tipo Description
ID do pedido
requestId True string

O id da solicitação para recuperar

Devoluções

Acionadores

Quando um pedido de assinatura é concluído

Aciona quando uma solicitação de assinatura é concluída por todas as partes.

Quando um pedido de assinatura é recusado

Aciona quando uma solicitação de assinatura é recusada.

Quando uma solicitação de assinatura é criada

Aciona quando uma nova solicitação de assinatura é criada.

Quando um pedido de assinatura é concluído

Aciona quando uma solicitação de assinatura é concluída por todas as partes.

Devoluções

Quando um pedido de assinatura é recusado

Aciona quando uma solicitação de assinatura é recusada.

Devoluções

Quando uma solicitação de assinatura é criada

Aciona quando uma nova solicitação de assinatura é criada.

Devoluções

Definições

RequestResponse

Name Caminho Tipo Description
ID do pedido
signature_request_id string

ID exclusivo da solicitação de assinatura.

Title
title string

Título do pedido de assinatura.

Assunto
subject string

Assunto do e-mail enviado aos signatários.

Message
message string

Mensagem personalizada no e-mail enviado aos signatários.

Está completo
is_complete boolean

True se a solicitação tiver sido totalmente executada por todos os signatários.

É recusado
is_declined boolean

True se a solicitação tiver sido recusada por um signatário.

URL de assinatura
signing_url string

URL onde um signatário, depois de autenticado, pode assinar os documentos.

Detalhes url
details_url string

URL onde o solicitante e os signatários podem visualizar o status atual da solicitação.

E-mail do solicitante
requester_email_address string

Endereço de e-mail do iniciador do pedido de assinatura.

Assinaturas
signatures array of object
ID da assinatura
signatures.signature_id string

Identificador exclusivo da assinatura.

E-mail do signatário
signatures.signer_email_address string

Endereço de e-mail do signatário.

Nome do signatário
signatures.signer_name string

Nome do signatário.

Código de estado
signatures.status_code string

Estado atual da assinatura.

Data de assinatura
signatures.signed_at date

Data no formato ISO UTC (AAAA-MM-ddTHH:mm:ss.fffZ)

Data da última visualização
signatures.last_viewed_at date

Data no formato ISO UTC (AAAA-MM-ddTHH:mm:ss.fffZ)

Data da última lembrança
signatures.last_reminded_at string

Data no formato ISO UTC (AAAA-MM-ddTHH:mm:ss.fffZ)