Primeiros passos

🚧

O envelope está ativo para contas criadas a partir de 01/07/2024. Caso receba o erro de serviço indisponível, entre em contato com [email protected]

📘

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. Caso queira consultar a versão anterior da documentação de API, que não usa envelopes, clique aqui. Caso tenha alguma dúvida ou sugestão, entre em contato com [email protected].

1. Crie uma conta no ambiente Sandbox

Para começar, você precisa criar uma conta no ambiente Sandbox. Entre em https://sandbox.clicksign.com/signup e crie uma conta.

2. Gere um Access Token

Vá até Configurações, depois entre na aba API e em seguida gere um Access Token.

3. Associar o usuário à API

Para liberar a utilização do access token para a conta, é necessário associar o usuário para a utilização da API.

4. Faça um teste de autenticação

Navegue até https://sandbox.clicksign.com/api/v3/envelopes?access_token={{access_token}} substituindo {{access_token}} pelo seu Access Token.

Exemplos de resposta:

{
	"data": [],
	"meta": {
		"record_count": 0
	},
	"links": {
		"first": "https://sandbox.clicksign.com/api/v3/envelopes",
		"last": "https://sandbox.clicksign.com/api/v3/envelopes"
	}
}