Introdução

A integração via Web Services possibilita a emissão de NF-e, NFC-e e CF-e através de um único leiaute de XML de entrada.

Principais funcionalidades:

  • Uso do equipamento S@T compartilhado entre vários PDVs
  • Opção de controle de numeração automático
  • Opção de controle de contingência automático
  • Acesso remoto aos dados do S@T como logs e status operacional

Endereços Web Services

Os Web Services seguem o padrão REST, a porta padrão de comunicação é 6679.

Exemplo de endereço para chamada:
http://{servidor}:6679/api/{servico}/{metodo}

Os serviços disponíveis estão listados abaixo.

  • Configuração
URL Método HTTP Descrição
/api/configuracao POST Configurar agente
/api/configuracao/resetar POST Resetar configuração do agente
  • Certificado
URL Método HTTP Descrição
/api/certificado/{sistema} GET Obter data de vencimento do certificado
  • Venda
URL Método HTTP Descrição
/api/venda/emissao POST Emitir nota
/api/venda/correcao/{chave} POST Corrigir a emissão de uma nota
/api/venda/cancelamento POST Cancelar nota
/api/venda/impressao/{chave} POST Imprimir nota
/api/venda/cartacorrecao POST Gerar carta de correção
/api/venda/inutilizacao POST Inutlizar nota
/api/venda/notanaoutilizada POST Nota não utilizada
/api/venda/danfe/{chave} GET Obter DANFe
/api/venda/consulta/{retaguarda}/{identificador} GET Consultar nota
/api/venda/xmls/{chave} GET Baixar XMLs da nota
  • SAT
URL Método HTTP Descrição
/api/sat/bloqueio POST Bloquear o S@T
/api/sat/desbloqueio POST Desbloquear o S@T
/api/sat/extrairlogs GET Extrair os logs do S@T
/api/sat/statusoperacional GET Consultar o status operacional do S@T

Emissão Normal

../_images/EmissaoNormal.png

Emissão com falha ao retornar dados

Em casos de falha ao obter o retorno da chamada ao endpoint de Emissão da Venda, realizar a consulta através do identificador para obter o resultado do processamento da venda.

../_images/EmissaoRetornoFalha.png

Emissão em Contingência Offline

Toda venda efetuada com Sucesso (SituacaoOperacao=1) cujo status da emissão for Validada em Contingência (Status=15) é considerada uma NFC-e emitida em Contingência Offline.

../_images/EmissaoOffline.png

Cancelamento de uma Venda

../_images/Cancelamento.png

Emissão da DANFe de uma Venda

../_images/DANFe.png

Emissão de Carta de Correção para NF-e (Modelo 55)

../_images/CartaCorrecao.png