Introdução

A Clicksign provê uma plataforma de assinatura eletrônica de documentos que atende aos requisitos de integridade, autenticidade e não repúdio da legislação brasileira. Saiba mais em https://www.clicksign.com.

Esta é a segunda versão da documentação de API da Clicksign, que inclui o uso de envelopes via API. Envelopes são uma forma de agrupar documentos e signatários em uma única entidade, facilitando o gerenciamento e a assinatura de documentos, além de novas formas de autenticação e funcionalidades. Caso queira consultar a versão anterior da documentação de API, que não usa envelopes, clique aqui.

Primeiros Passos

Pronto para começar? Nós tornamos o processo de integração simples e direto! Para te ajudar a dar os primeiros passos, criamos um guia prático que explica como gerar seu token de acesso e fazer sua primeira requisição à API.

Acesse nosso guia de primeiros passos para iniciar.

A Documentação

Esta documentação é dividida em 6 partes:

ENVELOPE: É a forma de realizar a integração back end com sua aplicação. É através da API REST que se dá, por exemplo, a criação de documentos, adição e remoção de signatários e finalização de documentos.
ACEITE VIA WHATSAPP: É a funcionalidade que permite aceitar termos ou acordos diretamente por meio do WhatsApp através da integração com a API Clicksign.
WEBHOOKS: São notificações dos eventos ocorridos na Clicksign para sua aplicação. Quando um evento ocorre, a Clicksign notifica a sua aplicação imediatamente, através de uma requisição HTTP POST para uma URL previamente cadastrada.
WIDGET EMBEDDED: É a integração front end que permite que assinaturas sejam realizadas dentro da sua aplicação. Ele preserva o fluxo contínuo do usuário em uma contratação por não implicar troca de contexto para o website da Clicksign.
SINGLE SIGN ON VIA SAML: É um padrão aberto que permite que provedores de identidade (IdP) passem credenciais de autorização para provedores de serviços (SP). Ele permite que a sua empresa tenha total controle sobre as políticas de segurança dos usuários cadastrados em sua conta Clicksign pois, após ter o SAML configurado, todos os usuários que possuam e-mail corporativo, com domínio igual ao configurado, terão essa forma de login (SSO via SAML) como padrão.

Conte com a nossa ajuda!

Em caso de dúvidas ou caso precise de apoio, entre em contato conosco através do e-mail [email protected] com o máximo de detalhes possível.