Informações gerais

Ambientes / Hosts

A Clicksign possui infraestruturas completamente separadas para os ambientes Sandbox e Produção, sendo que somente o ambiente de Produção executa processos que resultam assinaturas com validade jurídica.

O ambiente Sandbox foi criado para os desenvolvedores realizarem suas integrações e, quando estiverem prontos para entrada em produção, atualizarem apenas as variáveis Host e Access Token com os parâmetros do ambiente de Produção.

Os ambientes estão sempre na mesma versão, portanto quando ocorre uma atualização em Produção, a mesma atualização ocorre 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 deve ser enviado no caminho da requisição. Portanto, toda requisição deverá constar no path ?access_token=string-do-token.

Formato JSON

A API da Clicksign utiliza JSON como formato das requisições, tanto para requests como para response. O formato deve ser enviado através dos cabeçalhos HTTP: Accept: application/json e Content-Type: application/json.

Exemplo de requisição

GET /api/v1/documents/55fea7c2-0e5b-40dc-bacf-50fb8529f866?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Accept: application/json
Content-Type: application/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: app.clicksign.com/api/v1/documents.

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.