O que a tela faz, a API vai fazer.
A API pública da FISCALgov está sendo construída junto com o primeiro cliente dela. Esta página mostra o desenho, para você saber o que esperar e, se quiser, entrar antes.
Seis peças, decididas antes da primeira linha
Regras que valem desde o início, para o contrato não mudar debaixo de quem integrou.
Nenhum endereço de API está aberto ainda. Não publicamos exemplos de chamada para não parecer que algo já responde.
REST versionada em /v1
Mesmos nomes de campo do produto, em português (chaveAcesso, dataEmissao). Campo removido ou com sentido mudado só numa versão nova: o /v1 não quebra quem já integrou.
Chave de API com escopos
Cada chave pertence a uma conta e enxerga só as empresas e os módulos que você liberar. Chave de API nunca entra na tela, e a sessão da tela nunca entra na API.
Webhooks assinados
Nota nova, nota cancelada, certificado vencendo: um POST no seu endereço, assinado com HMAC-SHA256 e carimbo de tempo, com retentativa exponencial e registro de cada entrega. Nunca com o XML inteiro no corpo: vai o id e o link.
Idempotência
Todo POST aceita Idempotency-Key. Repetir a chamada depois de uma falha de rede não duplica nada.
OpenAPI gerada do código
A referência sai do próprio código da API, não de um documento paralelo. O que está lá é o que responde.
Ambiente de testes (previsto)
Um ambiente com empresas e notas de exemplo para integrar sem certificado de verdade e sem tocar na produção.
Para o seu sistema não ter que construir captura
ERPs e software houses
Em vez de manter a integração com a SEFAZ, com a base nacional da NFS-e e com os prazos de consumo de cada uma, o seu sistema lê os documentos prontos e recebe o aviso quando algo muda.
- Documentos com eventos, XML e PDF
- Webhook de nota nova e de cancelamento
- Fonte, data e hora em cada dado
- Conta do tipo integração, com as empresas dos seus clientes
Empresas com TI própria
Um grupo com vários CNPJs alimenta o ERP interno com as notas recebidas e as certidões, sem ninguém baixar XML de portal.
- Uma chave por sistema, com escopo por empresa
- Entregas de webhook registradas e reenviáveis
- Idempotência em todo POST
Perguntas de quem integra
O que vai estar na API?
O mesmo que a tela entrega, módulo a módulo: empresas monitoradas, certificados (só o estado, nunca o arquivo), documentos fiscais com eventos, XML e PDF, e, conforme os módulos forem liberados, certidões, e-CAC e Simples. O princípio do produto é um só contrato para a tela e para a API.
Quem é o primeiro cliente da API?
O SISGER, sistema de gestão da mesma casa, que vai consumir os documentos fiscais pela API e pelos webhooks. Ele é a prova de que o contrato aguenta um sistema de verdade antes de ser aberto a ERPs e software houses.
Posso integrar hoje?
Ainda não pela API. Hoje você pode usar a tela e baixar os XML. Se quer integrar o seu sistema, fale com a equipe: quem entra cedo ajuda a definir o contrato e é chamado para testar antes da abertura.
A API vai resolver captcha ou acessar portal por mim?
Não. A FISCALgov só fala com as fontes oficiais pelas interfaces oficiais, com o certificado de cada empresa, e nunca resolve captcha por máquina. A API entrega o que a plataforma capturou, com fonte, data e hora de cada dado.
Dúvida técnica? [email protected]
Quer integrar antes da abertura?
Conte o que o seu sistema precisa. Quem entra cedo ajuda a definir o contrato e testa antes da abertura.