Introdução a API

Seja bem-vindo a API da Contraktor! Somos uma plataforma de gestão de documentos e assinatura eletrônica. É através desta API que você irá integrar o seu sistema ao nosso. Você poderá utilizar todos os recursos da plataforma através dessa API, por exemplo: Enviar documentos para assinatura e exibi-los em seu website, mantendo o usuário em seu ambiente.

🚧

Nossa API é RESTful e todas as respostas são em JSON.

Ambientes

Possuímos dois ambientes de integração com a nossa API, o ambiente de Sandbox, onde será possível testar as requisições em documentos sem validade jurídica e sem cobrança, além do ambiente de produção, onde todos os documentos passarão a ter valor jurídico.

No link abaixo te orientamos a como conseguir seu acesso ao ambiente de homologação:

📘

Solicitar acesso ao Sandbox

Endpoints

API Token

Para conseguir realizar as chamadas na nossa API, além do endpoint, você precisará do API Token. Existe um valor de token para cada ambiente, é necessário utilizar o token correto em relação ao ambiente que está integrando para sua autorização ser validada através da nossa API.

Vale lembrar que todas as nossas rotas são protegidas e será necessário se autenticar em cada endpoint. Para se autenticar, basta seguir o exemplo abaixo:

headers = {
  'Authorization': f'Bearer {api_key}'
}

headers: {
    Authorization: `Bearer ${api_key}`
  }

📝 Certifique-se de atribuir o valor do token obtido a variável {api_key}.

Fluxograma da documentação

Abaixo anexamos o fluxograma detalhando os passos para criação do contrato através da nossa API. Caso queira adicionar informações complementares ao contrato, acesse os tópicos listados abaixo que estão contidos nessa documentação.

Passo a passo

No link abaixo, preparamos um guia completo para conseguir sua chave de acesso:

📘

Adquirir API Token

Exemplos

No link abaixo disponibilizamos um repositório com exemplos em Node.js de como utilizar nossa API:

📘

Contraktor Public API | Node.js