Primeiros passos
Visão geral da Open API da TF Fiscal, suas capacidades, os três passos de integração e por onde continuar a leitura.
A TF Fiscal é uma plataforma de documentos fiscais para o Brasil. Por meio de uma única API HTTP assinada, sua aplicação emite NF-e, CT-e e DC-e em nome das empresas que você cadastra, verifica NF-e de terceiros junto à SEFAZ, consulta dados cadastrais de CNPJ e CPF e recebe todo resultado assíncrono por webhooks.
Capacidades
| Capacidade | O que faz | Documentação |
|---|---|---|
| NF-e | Emitir, consultar e cancelar NF-e (modelo 55) para as empresas cadastradas; registrar e listar cartas de correção (CC-e) | NF-e |
| CT-e | Emitir, consultar e cancelar CT-e (modelo 57, modal rodoviário) e registrar eventos pós-autorização | CT-e |
| DC-e | Emitir, consultar e cancelar DC-e (modelo 99) para marketplaces e empresas que emitem para si mesmas | DC-e |
| Verificação de NF-e | Verificação em duas camadas de arquivos XML de NF-e de terceiros, além de consulta pela chave de acesso | Verificação de NF-e |
| Consulta cadastral | Dados cadastrais oficiais de um CNPJ, ou de um CPF junto com a data de nascimento | Consulta cadastral |
| Webhooks | Callbacks assinados com resultados de emissão, eventos pós-autorização e vereditos de verificação | Webhooks |
Empresas, certificados e a configuração de webhook são compartilhados por todos os tipos de documento emitidos: uma empresa cadastrada uma vez pode emitir NF-e, CT-e e DC-e. Veja Empresas.
Como funciona uma integração
- Obtenha as credenciais e subscreva. Solicite uma aplicação e receba o seu
app_secret. Ele é exibido apenas uma vez; mantenha-o no servidor. A plataforma então subscreve a aplicação aos endpoints de que você precisa; chamar um endpoint não subscrito devolve HTTP 403 com o código10009005. - Valide a sua assinatura. Toda requisição é assinada com
MD5(token + path + body + timestamp)e carrega os cabeçalhostoken,timestampesign. Faça do Echo de teste a sua primeira chamada: ele valida toda a cadeia de assinatura e devolve a identidade da sua aplicação. - Integre por domínio. Integrações de emissão cadastram uma empresa, vinculam o certificado, registram um webhook e então emitem documentos. Integrações de verificação e de consulta cadastral precisam apenas da chamada assinada, mais um webhook para receber os vereditos de verificação.
Por onde começar
- Início rápido: as cinco chamadas de uma integração de emissão, com exemplos curl executáveis.
- Autenticação: modelo de credenciais, regras de assinatura, vetores de assinatura conhecidos e implementações de referência em cinco linguagens.
- Convenções gerais: formatos de resposta, tipificação de erros, idempotência, limites de taxa, localização e tipos de dados.
- Ambientes: URL base e como uma empresa passa do ambiente de teste para produção.
Nota: todos os endpoints ficam sob
https://api.v2.tffiscal.com/openapi/.