Passar para o conteúdo principal

API Lite: entenda o que é e como funciona a integração via API

Entenda mais sobre a a API do Lite e como usá-la

Escrito por Julia S.

O que é a API Lite

A API Lite é uma API REST que permite consultar Notas Fiscais Eletrônicas (NFe) a partir da chave de acesso e integrar esse retorno diretamente ao sistema interno do cliente (ERP ou aplicação própria), sem necessidade de acesso manual a um portal.

A consulta é feita sem certificado digital e, por isso, o XML retornado não possui validade jurídica para fins de escrituração contábil ou fiscalização oficial — a API atua como uma camada de acesso rápido aos dados da nota, não como substituto da gestão fiscal completa da Qive.


Diferença entre API Lite e Qive Lite

É comum confundir os dois nomes, mas são soluções diferentes:

  • Qive Lite — portal web para consulta manual e avulsa de uma nota por vez, pela chave de acesso, direto no navegador.

  • API Lite — integração via API para que o sistema do cliente consulte notas de forma automatizada e em volume, sem interação manual com um portal.

Ambas compartilham a mesma limitação: consulta sem certificado digital e sem validade jurídica plena.


O que a API Lite permite consultar

  • Busca de NFe por chave de acesso — retorna o XML da nota (codificado em Base64) a partir de uma chave de acesso válida.

  • Consulta de status da NFe — retorna a situação da nota a partir da mesma chave de acesso.

Em ambos os casos, a consulta é feita por requisição GET, enviando a chave de acesso (44 caracteres numéricos) como parâmetro na URL. O acesso aos endpoints é feito com credenciais próprias de integração, fornecidas no momento da ativação da conta.


Como funciona o consumo de créditos (pacotes)

O uso da API Lite é organizado em pacotes de requisições, com regras específicas:

  • Cada conta contratada é vinculada a um serviço de origem por vez (Serpro ou Portal Sefaz) — não é possível alternar entre os dois no mesmo pacote.

  • Os pacotes têm um período de vigência (normalmente mensal) e não são cumulativos: requisições não utilizadas dentro do período não passam para o ciclo seguinte.

  • Existe um limite de tentativas por intervalo de tempo (throttle), configurado para cada conta, que evita excesso de chamadas simultâneas.

Quando uma requisição consome crédito do pacote:

Situação

Consome crédito?

XML retornado com sucesso

Sim

Chave inexistente na base do órgão consultado

Sim (houve processamento e consulta)

Instabilidade no serviço do órgão consultado

Sim (houve tentativa de comunicação)

Erro interno da API (falha da própria Qive)

Não

Ou seja: o crédito é consumido sempre que a Qive efetivamente processa e tenta a consulta — só não é descontado quando a falha é interna e a nota não chega a ser processada.


Documentação técnica

Para especificações completas de endpoints, parâmetros e formatos de resposta, consulte a documentação oficial da API.


Como contratar ou testar a API Lite

Se você tem interesse em ativar a API Lite para o seu sistema — seja para teste ou contratação —, entre em contato com o nosso time de atendimento. Eles vão avaliar seu cenário de uso (volume de chaves, sistema interno e necessidade de status de NFe) e conduzir a ativação da sua conta.

Respondeu à sua pergunta?