Autenticação
Autentique com uma chave de API
Integrações servidor a servidor (ERP, BI, automações) chamam a API com uma chave de API da licença, enviada em Authorization: Bearer <chave>. A chave age em uma única empresa, só nas operações dos seus escopos, e cada chamada fica na auditoria como Integração · Chave de API: <nome>.
Onde criar
No app ClickFin, um Administrador abre Configurações → Integrações e cria a chave: nome, empresa, escopos e, se quiser, IPs permitidos e validade (até 2 anos). A chave completa aparece uma única vez; a ClickFin guarda só um hash e não consegue mostrá-la de novo.
Formato e endereço
- A chave tem o formato
cf_live_<id>_<segredo>. - Todas as chamadas vão para
https://api.clickfin.com.br. - Cada chamada age nos dados reais da empresa da chave.
- A API está disponível nos planos pagos e para parceiros.
Enviando a chave
Leia a chave de uma variável de ambiente ou de um cofre de segredos do seu servidor. Ela nunca vai para o navegador, para um app móvel ou para o controle de versão: quem tem a chave age como a sua empresa.
curl --request GET \ --url "https://api.clickfin.com.br/client?page=1&limit=10" \ --header "Authorization: Bearer $CLICKFIN_API_KEY"Escopos
Cada operação desta referência exige um escopo, mostrado na página dela. Sem o escopo, a resposta é 403 API_KEY.SCOPE_REQUIRED com details.requiredScope; rotas fora desta referência (login, usuários, empresas, configurações) respondem 403 API_KEY.ROUTE_NOT_ALLOWED. write não inclui read: peça os dois quando precisar.
| Escopo | Acesso | Operações |
|---|---|---|
bank_slips:read | leitura | 5 |
bank_slips:write | escrita | 3 |
clients:read | leitura | 3 |
clients:write | escrita | 3 |
contracts:read | leitura | 3 |
contracts:write | escrita | 4 |
market_segments:read | leitura | 2 |
market_segments:write | escrita | 3 |
payables:read | leitura | 3 |
payables:write | escrita | 6 |
receivables:read | leitura | 2 |
receivables:write | escrita | 4 |
reports:read | leitura | 1 |
service_invoices:read | leitura | 8 |
service_invoices:write | escrita | 4 |
services:read | leitura | 2 |
services:write | escrita | 3 |
suppliers:read | leitura | 2 |
suppliers:write | escrita | 3 |
Rotação
Em Configurações → Integrações, "Rotacionar" gera uma chave nova com o mesmo nome, empresa, escopos e IPs. A anterior continua valendo pela sobreposição escolhida (0, 24 horas ou 7 dias; no máximo 168 horas) e depois expira sozinha: troque a chave no seu servidor dentro desse prazo.
Revogação
Revogar vale na requisição seguinte, sem cache. Revogue na hora se a chave vazar e crie outra. Chave revogada, expirada ou de empresa excluída responde 401 API_KEY.INVALID.
Contrato e ferramentas
O contrato OpenAPI desta referência é publicado pela própria API e pode ser importado no Bruno, Postman ou Insomnia. Ele contém só as operações que aceitam chave.