Integração Ploomes e Clicksign
Este guia detalhado irá auxiliar você na realização da integração entre a plataforma Ploomes e a Clicksign. A integração estabelece um fluxo automatizado para o envio de documentos para assinatura, garante o retorno em tempo real do status e permite a visualização do documento assinado para a Ploomes.
Visão geral da integração
A integração funciona como uma comunicação bidirecional: a Ploomes utiliza o Token da Clicksign para enviar documentos e a Clicksign utiliza o Webhook da Ploomes para enviar as atualizações de status.
Atenção: É necessário utilizar o mesmo e-mail na Ploomes e na Clicksign ao gerar o Token de Autenticação para que a integração seja bem-sucedida.
Como fazer a configuração inicial na Ploomes?
Nesta etapa, você inicia o processo de integração dentro da Ploomes.
- No menu lateral da Ploomes, vá até a opção Administração.
- Clique em Integrações Plug and Play.
- Localize e selecione o ícone da ClickSign.
- Clique em Habilitar a integração.
- Em seguida, clique em Autorizar a integração.
Como obter o Token de autenticação na Clicksign?
O sistema solicitará um Token de Autenticação. Este Token é a chave que permite à Ploomes enviar documentos à Clicksign.
- Na tela de início da Clicksign, vá ao menu lateral, clique em Configurações e, em seguida, em API.
- No campo de usuário, insira o mesmo e-mail utilizado na Ploomes.
- Clique em Gerar access token.
- Insira uma descrição para identificar o token (ex: Integração Ploomes) e clique em Gerar.
- Após a geração, copie o código do token.
Como finalizar a autorização e configurações opcionais na Ploomes?
Com o Token em mãos, você retorna à Ploomes para finalizar a autorização.
- Volte à Ploomes e insira o token no campo solicitado. Em seguida, clique em Confirmar. A integração estará autorizada.
- Neste momento, você pode configurar opções adicionais da integração conforme sua necessidade:
- Importar os documentos para a Ploomes após assinados.
- Finalizar o documento após a última assinatura.
- Inserir uma mensagem padrão para ser enviada ao requisitar a assinatura.
Como ativar a integração e configuração do Webhook (Clicksign)?
Esta é a etapa mais importante para garantir que a Ploomes receba as atualizações de status da Clicksign.
- Clique em Ativar a integração na Ploomes.
- Será gerada uma URL (o Webhook) que você deve copiar.
- Vá até o site da Clicksign, na mesma tela em que você gerou o token (API).
- Clique em Adicionar Webhook.
- Cole a URL copiada da Ploomes no campo de endereço.
- Selecione os eventos que você deseja monitorar ou escolha todos os eventos.
- Clique em Adicionar. Você obterá um retorno de sucesso, finalizando as etapas no site da Clicksign.
Como obter a confirmação final na Ploomes?
O último passo é verificar se a conexão está ativa.
- Retorne à Ploomes e clique em Atualizar a integração.
- Ao obter um retorno de sucesso, feche a tela.
- Verifique o status da integração da Clicksign. Estando conforme o esperado, ela já estará ativa para uso.
Resumo: Você configurou o remetente (Ploomes) e o entregador (ClickSign) usando a mesma chave (Token) e estabeleceu um endereço de retorno (Webhook) para que as confirmações de status voltem automaticamente para a Ploomes.
Acesse a página da integração Ploomes.