Pular para o conteúdo principal

Fluxo de Integração

Esta página apresenta o fluxo recomendado de integração com o Emissor Fiscal, organizando as etapas da jornada de forma lógica e sequencial.

O objetivo é orientar a automação sobre:

  • quando cada etapa deve ser executada
  • quais interfaces e documentações devem ser consultadas em cada fase
  • como navegar pela documentação técnica de forma estruturada

Este fluxo contempla a integração para documentos fiscais de mercadoria (NF‑e e NFC‑e) e de serviços (NFS‑e).

Embora compartilhem etapas comuns de configuração e homologação, a NFS‑e possui particularidades técnicas e fiscais, principalmente relacionadas ao processamento municipal, podendo envolver processamento síncrono ou assíncrono. Nesses cenários, o retorno inicial indica o recebimento da solicitação, e a autorização da NFS‑e deve ser confirmada por meio de consultas posteriores.

Esta página não entra em detalhes técnicos de implementação.
Ela atua como um mapa de navegação para toda a documentação de integração.

Visão Geral​

De forma resumida, a integração com o Emissor Fiscal segue o fluxo abaixo:

  1. Definição das interfaces de integração
  2. Configurações iniciais e pré-requisitos
  3. Implementação dos processos de emissão
  4. Integração com APIs auxiliares (quando aplicável)
  5. Testes, homologação e validação final

Cada etapa está detalhada a seguir, com os respectivos links para as páginas específicas da documentação.

Etapa 1 – Definir as Interfaces de Integração​

O primeiro passo da integração consiste em definir quais interfaces do Emissor Fiscal serão utilizadas, conforme o modelo de operação da automação.

Essa decisão é fundamental, pois impacta:

  • arquitetura técnica
  • estratégia de contingência
  • forma de emissão dos documentos fiscais

Interfaces disponíveis​

Client 2.0
Indicado para operações locais com necessidade de contingência offline.

Documentações relacionadas:

Client em Nuvem
Indicado para sistemas web e ambientes multi-tenant, com emissão online.

Para o Client em Nuvem não há etapas de instalação ou configuração local. Por se tratar de um componente 100% online, a validação do fluxo ocorre diretamente por meio do consumo das APIs em ambiente de homologação, não sendo necessária uma etapa específica de homologação técnica como ocorre no Client 2.0.

Documentações relacionadas:

Integração Direta
Utilizada de forma complementar, por meio do consumo das APIs do Emissor Fiscal.

Documentações relacionadas:

NFS-e
A integração para emissão NFS‑e segue um fluxo específico, distinto dos documentos de mercadoria, considerando as regras, layouts e formas de processamento definidas por cada município.

Devido à autonomia dos municípios, regras de validação, prazos de retorno e layouts podem variar. Essas particularidades estão detalhadas na documentação específica de NFS‑e.

Documentações relacionadas:

A definição correta das interfaces deve ser realizada antes do início da implementação técnica.

Etapa 2 – Realizar as Configurações Iniciais​

Após definir as interfaces de integração, devem ser concluídos os pré-requisitos operacionais e cadastrais, que envolvem alinhamentos entre:

  • Produto / Automação
  • Credenciamento
  • Emissor Fiscal

Essa etapa garante que a integração possa avançar sem bloqueios no momento de homologação ou produção.

Documentação relacionada:

Importante: o desenvolvimento técnico só deve ser iniciado após a conclusão dessas configurações.

Etapa 3 – Implementar os Processos de Emissão​

Com as interfaces definidas e as configurações iniciais concluídas, a automação pode avançar para a implementação dos processos de emissão fiscal, conforme os documentos suportados.

Para o fluxo de NFS‑e, a implementação envolve o envio de RPS e a posterior confirmação da conversão em NFS‑e, conforme o modelo de processamento definido pelo município.

Essa etapa contempla:

  • estruturação dos payloads
  • consumo das rotas de emissão
  • tratamento de retornos e contingência

Documentações relacionadas:

Importante: o desenvolvimento técnico só deve ser iniciado após a conclusão dessas configurações.

Etapa 4 – Integrar APIs Auxiliares​

Caso a automação necessite de funcionalidades complementares ao processo de emissão, como consultas e dados auxiliares, deve-se integrar as APIs Auxiliares do Emissor Fiscal.

Documentação relacionada:

Etapa 5 – Testes e Homologação​

Após a implementação, a integração deve passar por testes controlados para validação do comportamento técnico e fiscal.

Essa etapa contempla:

  • testes funcionais com cliente piloto
  • validação em ambiente de homologação
  • testes de volumetria (quando aplicável)

Somente após a aprovação nessa fase a integração estará apta para operação em Produção.

Documentações relacionadas:

Conclusão do Fluxo​

Seguindo as etapas descritas neste fluxo, a automação garante que a integração com o Emissor Fiscal seja realizada de forma:

  • organizada
  • previsível
  • alinhada com os processos do produto
  • preparada para operação em escala

Este conteúdo foi útil para você?