Ambientes / Hosts

A Clicksign oferece dois ambientes para você desenvolver e usar a API:

🧪 Sandbox (Desenvolvimento)

• Para testes e desenvolvimento da sua integração • Documentos criados aqui não têm valor legal • Ambiente seguro para experimentar • Sempre na mesma versão do ambiente de produção

🏢 Produção (Uso real)

• Para uso real com clientes e processos oficiais • Documentos assinados aqui têm validade jurídica • Ambiente para sua aplicação final

Como migrar do Sandbox para Produção?

Quando estiverem prontos para migrar para o ambiente de Produção, basta atualizar as variáveis Host e Access Token com os parâmetros correspondentes. s ambientes Sandbox e Produção estão sempre na mesma versão. Portanto, todas as atualizações realizadas no ambiente de Produção também são refletidas automaticamente no ambiente Sandbox.

Autenticação

A autenticação é realizada através do parâmetro access_token que identifica e autentica o usuário. O parâmetro pode ser enviado no header da requisição, com a chave Authorization.

Formato JSON (JSON:API)

A API Clicksign utiliza a especificação da JSON:API para todas as requisições e respostas. Você deve configurar os cabeçalhos HTTP para indicar que está enviando e esperando receber dados no formato:

• Accept: application/vnd.api+json
• Content-Type: application/vnd.api+json

GET /api/v3/envelopes HTTP/2
Host: sandbox.clicksign.com
Authorization: {{access_token}}
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

curl --request GET \
  --url 'https://sandbox.clicksign.com/api/v3/envelopes' \
  --header 'Authorization: {{access_token}}' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'accept: application/vnd.api+json'

Formatação de datas

Para padronização, todas as datas devem ser formatadas de acordo com a norma ISO 8601, por exemplo: 2020-02-05T15:40:15.335-03:00.

As respostas das requisições sempre estarão no fuso horário UTC.

Versões da API

Para possibilitar a evolução contínua da API, a Clicksign implementa um sistema de versões. Dessa forma é necessário que as requisições contenham a versão da API através do path, por exemplo: sandbox.clicksign.com/api/v3/envelopes.

Uma nova versão é lançada apenas quando há quebra de funcionalidade. Ou seja, melhorias, novas funcionalidades e correções de bugs, desde que não alterem o comportamento esperado, não implicam lançamento de uma nova versão.