developers.contraktor.com.br Open in urlscan Pro
172.67.71.89  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Jump to Content

GuidesAPI ReferenceChangelogDiscussions
v1.0

--------------------------------------------------------------------------------

Log In
Guides
Log In

v1.0GuidesAPI ReferenceChangelogDiscussions
Introdução a API
Search
CTRL-K
All
Guides
Reference
Changelog
Discussions

START TYPING TO SEARCH…


CONTRAKTOR API

 * Introdução a API
 * Planos de API
 * Postman


ARQUIVOS

 * Upload de Arquivos
 * Listagem de Arquivo


CONTRATOS

 * Criar Contrato
 * Listagem de Contratos
 * Atualizar Contrato
 * Deletar Contrato


PESSOAS

 * Adicionar Participante
 * Atualizar Participante
 * Listagem de Participantes
 * Deletar Participante


SHARES

 * Adicionar Participante ao Contrato
 * Listagem de Participantes do Contrato
 * Atualizar Participante do Contrato
 * Deletar Participante do Contrato


PROOF

 * Criar Proof
 * Listagem de Proof
 * Reenvio de Assinaturas
 * Deletar Proof


WORKFLOWS

 * Criar Workflow
 * Listagem de Workflows
 * Atualizar Workflow
 * Deletar Workflow


DATAS

 * Adicionar Datas ao Contrato


TAREFAS

 * Criar Tarefas
 * Listagem de Tarefas
 * Atualizar Tarefa
 * Deletar Tarefa


FINANCEIRO

 * Criar Lançamento Financeiro
 * Atualizar Lançamento Financeiro
 * Deletar Lançamento Financeiro


ANEXOS

 * Anexar Documentos
 * Deletar Anexo


ATIVIDADES

 * Criar Comentário
 * Deletar Comentário


AÇÕES EM LOTE

 * Assinar em Lote
 * Arquivar em Lote
 * Deletar em Lote


MODELOS

 * Criar Modelo
 * Listagem de Modelos
 * Deletar Modelo
 * Criar Contrato


WEBHOOKS

 * Webhook

Powered by 


INTRODUÇÃO A API

Guia de referências para API da Contraktor

Suggest Edits

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.

AmbienteValidade jurídicaSandboxNãoProduçãoSim

⚠️ Se você ainda não realizou nenhuma integração com a Contraktor, recomendamos
que você inicie pelo ambiente de testes (sandbox) para evitar cobranças
indevidas e para conhecer melhor todos os recursos da nossa API.

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


> 📘
> 
> SOLICITAR ACESSO AO SANDBOX


ENDPOINTS

AmbienteEndpointValidade
jurídicaSandboxhttps://api-sandbox.contraktor.com.br/apiNãoProduçãohttps://api-v3.contraktor.com.br/apiSim


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.

AmbienteEndpointAPI TokenSandboxhttps://api-sandbox.contraktor.com.br/apiAPI
Token de SandboxProduçãohttps://api-v3.contraktor.com.br/apiAPI Token de
Produção

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:

PythonNode
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.

📌 Clique na imagem acima para melhor visualizaçã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

Updated 7 days ago

--------------------------------------------------------------------------------

Planos de API
Did this page help you?
Yes
No
 * Table of Contents
 * * Ambientes
   * Endpoints
   * API Token
   * Fluxograma da documentação
   * Passo a passo
   * Exemplos