Para desenvolvedores

A API de nota fiscal do ClickNotas

Emita NF-e, NFC-e e NFS-e direto do seu sistema, com os mesmos cadastros de clientes, produtos e serviços. REST, JSON e autenticação por token.

Ver a documentação Criar conta e testar

REST em JSON, com especificação OpenAPI para baixar
Emissão e cancelamento de NF-e, NFC-e e NFS-e
Chaves criadas por você, na tela de Integração via API

clicknotas.com/notas-fiscais/nfe/nova

Nova NF-e

Nota fiscal de produtos

Cliente

Casa & Obra Materiais Ltda

Produto

Cimento CP II 50 kg

NCM

2523.29.10

Quantidade

Valor unitário

R$ 24,06

Total

R$ 962,40

Observações

Entrega na obra, portão 2

SalvarEmitir NF-e

Tabela NCM integradadireto no cadastro do produto

REST e JSON

Servidor https://api.clicknotas.com

Dois tokens

Access e Secret Access Token

OpenAPI

Arquivo para baixar e importar

3 req/s

30.000 requisições por dia

Primeira chamada

Autenticou, emitiu

Os dois tokens vão em todas as requisições, como cabeçalho. Crie a nota e depois chame a emissão: é a mesma sequência do sistema.

# 1. cadastra a nota fiscal de produtos
curl -X POST https://api.clicknotas.com/notas_fiscais_produtos \
  -H "access-token: SEU_ACCESS_TOKEN" \
  -H "secret-access-token: SEU_SECRET_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "cliente_id": 123, "produtos": [{ "produto_id": 456, "quantidade": 2 }] }'

# 2. emite na Sefaz a nota criada no passo 1
curl -X POST https://api.clicknotas.com/notas_fiscais_produtos/emitir/789 \
  -H "access-token: SEU_ACCESS_TOKEN" \
  -H "secret-access-token: SEU_SECRET_ACCESS_TOKEN"

Como começar

Três passos até a primeira nota pela API

Não precisa falar com ninguém: as chaves são criadas por você, dentro do sistema.

Crie sua conta

O teste grátis já libera a API. Se você é parceiro ou contador, use a conta do cliente que vai emitir as notas.

Gere as credenciais

Na tela de Integração via API, crie a chave com nome e validade. O Access Token e o Secret Access Token aparecem ali — o segredo aparece uma vez só, guarde com cuidado.

Chame a API

Mande os dois tokens em toda requisição, cadastre a nota e chame a emissão. A documentação traz cada campo, e o arquivo OpenAPI importa direto no Postman ou no Insomnia.

Abrir a documentação

Endpoints

O que a API expõe hoje

Cadastros e catálogo com listar, visualizar, cadastrar, editar e excluir. Notas fiscais com emissão e cancelamento além do cadastro.

Cadastros e catálogo

Clientes, fornecedores, transportadoras, produtos e serviços

GET/clientes
POST/clientes
PUT/clientes/{id}
GET/produtos
POST/produtos
GET/servicos
GET/fornecedores
GET/transportadoras

Notas fiscais

NF-e, NFC-e e NFS-e: cadastrar, emitir e cancelar

GET/notas_fiscais_produtos
POST/notas_fiscais_produtos
POST/notas_fiscais_produtos/emitir/{id}
POST/notas_fiscais_produtos/cancelar/{id}
POST/notas_fiscais_consumidores/emitir/{id}
POST/notas_fiscais_servicos/emitir/{id}
GET/notas_fiscais_servicos/{id}
DELETE/notas_fiscais_produtos/{id}

Apoio

O que você precisa para preencher as notas

GET/usuarios
GET/lojas
GET/formas_pagamentos

A lista completa, com todos os campos de cada requisição, está na documentação.

Regras que valem para todas as chamadas

O que você precisa saber antes de integrar

Autenticação por dois tokens

Access Token e Secret Access Token em toda requisição, como cabeçalho HTTP. As chaves têm nome e validade, e podem ser revogadas quando você quiser.

Limite de requisições

Até 3 requisições por segundo e 30.000 por dia, por empresa. Acima disso a resposta vem com status 429, e basta reduzir o ritmo.

Listagens paginadas

Toda listagem vem paginada, com no máximo 100 registros por página. Use pagina, limite, ordenacao e direcao para percorrer o resto.

Qual usuário registra

Empresa com mais de um usuário manda usuario_id na chamada. Sem esse campo, a API registra tudo no usuário master. Os ids saem de GET /usuarios.

Qual loja emite

Empresa com mais de uma loja manda loja_id. Sem esse campo, vale a matriz ou a loja que o usuário tem permissão de acessar.

OpenAPI para importar

A documentação tem o arquivo OpenAPI para baixar e importar no Postman, no Insomnia ou no gerador de cliente da sua linguagem.

A API faz o que o usuário dela pode fazer

O token herda as permissões do usuário e da loja a que pertence. Se a chamada volta dizendo que não há permissão para o registro, o ajuste é nas permissões desse usuário, dentro do sistema. O artigo sobre permissões do token, logo abaixo, mostra onde mexer.

Perguntas frequentes

Dúvidas de quem vai integrar

Consigo emitir nota fiscal direto pela API ou só pelo sistema?+

Direto pela API. A emissão tem duas etapas: primeiro você cadastra a nota (POST) e depois chama a emissão daquela nota (POST em /notas_fiscais_produtos/emitir/{id}). Vale para NF-e, NFC-e e NFS-e, cada uma no seu endereço.

Criei a nota pela API, mas ela ficou em aberto e não foi para a Sefaz+

Cadastrar a nota não envia nada. O cadastro só cria o registro; quem transmite é a chamada de emissão, feita depois, com o id da nota criada. Enquanto essa segunda chamada não acontece, a nota fica em aberto no sistema.

Como gerar o Access Token e o Secret Access Token?+

Na tela de Integração via API, dentro do sistema, você cria a chave com nome e validade. Os dois códigos aparecem ali. O segredo aparece uma única vez: se perder, o caminho é revogar a chave e criar outra.

Posso ter mais de uma chave de API na mesma conta?+

Pode, e é o recomendado quando mais de um sistema consome a API: uma chave por integração, cada uma com seu nome e sua validade. Revogar uma não derruba as outras.

Qual é o limite de requisições da API?+

São 3 requisições por segundo e 30.000 por dia, por empresa. Ao passar do limite, a resposta vem com status 429 e a mensagem de limite atingido. Espere um instante e repita a chamada com um ritmo menor.

A API tem documentação e arquivo OpenAPI?+

Tem. A documentação lista cada endpoint com os campos aceitos, e traz o arquivo OpenAPI para baixar. Com ele você importa a API no Postman ou no Insomnia e gera cliente na sua linguagem.

Recebi erro de CORS ao chamar a API pelo navegador+

A API é para chamada de servidor, não do navegador do visitante. Chamar do front expõe seus tokens e esbarra no CORS. Faça a chamada no seu backend e guarde os dois tokens lá.

A API funciona no teste grátis?+

Funciona. O teste grátis já permite criar as credenciais e integrar, então você consegue validar a emissão antes de contratar. Para emitir de verdade, a empresa precisa do certificado digital configurado.

Central de Ajuda

Artigos da Central de Ajuda sobre a API

Passo a passo, erro por erro, escrito para quem está integrando agora.

Ver todos os artigos da Central de Ajuda

Comece a integrar hoje

Crie a conta, gere as chaves na tela de Integração via API e faça a primeira chamada em minutos.

Teste grátis Ver a documentação