Monitoramento NFe — Visão Geral do Fluxo

A Q'Prof API disponibiliza serviços para acompanhamento do status de monitoramento de NF-e presentes no Qprof (quando o serviço está parametrizado).

ℹ️ Importante: parte deste fluxo são callbacks implementados pelo cliente. Ou seja, o seu sistema deve expor uma API para receber as chamadas do Q'Prof. Apenas o receberStatusNfe é um endpoint exposto pelo Q'Prof.

Papéis

Quem expõe	Serviço	Direção	Descrição
Cliente	`monitoraNfe`	Qprof → Cliente	Inicia (Start) o monitoramento de NF-e.
Cliente	`alteraStatusMonitoramento`	Qprof → Cliente	Para (Stop) ou continua (Continue) o monitoramento.
Qprof	`POST /servicos/controladoria/receberStatusNfe`	Cliente → Qprof	Recebe o status atualizado das NF-e para gravação no Qprof.

Fluxo típico

        ┌─────────────────────────────────────────────────────────┐
        │                        Qprof                            │
        └─────────────────────────────────────────────────────────┘
              │ (1) Start                          ▲ (3) status
              │  monitoraNfe                       │  receberStatusNfe
              ▼                                    │
        ┌─────────────────────────────────────────────────────────┐
        │                    Sistema do Cliente                   │
        └─────────────────────────────────────────────────────────┘
              ▲ (2) Stop/Continue
              │  alteraStatusMonitoramento

Start — o Qprof chama monitoraNfe no seu sistema para iniciar o monitoramento de um conjunto de NF-e.

Stop/Continue — quando necessário, o Qprof chama alteraStatusMonitoramento para parar ou retomar o monitoramento.

Atualização — o seu sistema chama receberStatusNfe no Qprof para enviar o status atualizado (ex.: "Em rota", "Entregue").

Padrão de comunicação dos callbacks (cliente)

Vale para monitoraNfe e alteraStatusMonitoramento:

Autenticação em 2 etapas (mesmo padrão da Qprof API): seu sistema deve expor também um método authentication.

O corpo trafega como arquivo gzip (JSON comprimido), devido ao possível volume de dados.

A resposta deve conter apenas o HTTP Status Code 200 (sucesso) ou 400 (falha) e, no corpo, um JSON com a mensagem:

{
  "sucesso": true,
  "mensagem": "Retorno recebido com sucesso."
}

Detalhes de cada callback

Callback: Início do Monitoramento (monitoraNfe)

Endpoint Qprof: Receber Status Monitoramento

Monitoramento NFe — Visão Geral do Fluxo

Papéis#

Fluxo típico#

Padrão de comunicação dos callbacks (cliente)#

Detalhes de cada callback#

Papéis

Fluxo típico

Padrão de comunicação dos callbacks (cliente)

Detalhes de cada callback