Introdução API de Integração PDV

Filtros


Atalhos para busca

Objetivo

Orientar o desenvolvedor sobre como integrar sua aplicação com a API PDV da Consinco através da descrição das funcionalidades, dos métodos a serem utilizados, das informações a serem enviadas e recebidas, bem como através de exemplos.

O mecanismo de integração com API é simples, de modo que apenas conhecimentos intermediários em linguagem de programação para Web, requisições HTTP ou HTTPS e manipulação de dados no formato JSON, são necessários para realizar a integração com sucesso.

Usando padrões internacionais de comunicação a API PDV foi desenvolvida no formato Rest(JSON), permitindo conectar bancos de dados e softwares desenvolvidos em diferentes linguagens.

No final desta documentação, constam exemplos de fluxo de utilização que simplificam a integração.

Princípios básicos

Acesso

Todas as chamadas à sua API serão feitas através do endereço de IP e Porta configuradas no Monitor de PDVs.

Autenticação

Opcionalmente, a autenticação poderá ser feita utilizando o HTTP Basic Auth, com usuário e senha configurados no Monitor de PDVs.

Arquitetura

MÉTODO DESCRIÇÃO
Request Ação executada sempre pela API PDV
Response Ação executada sempre pela API do Integrador(Parceiro)

 

Operação

Definem em que ciclo de operação o PDV se encontra, sendo eles:

  • Início da Venda: cotStartSale – O evento(ação) ocorrerá antes de registrar qualquer item ou qualquer identificação de pessoas.
  • Subtotal da Venda: cotSubtotalSale – O evento(ação) ocorrerá antes de iniciar o pagamento da venda.
  • Finalização da Venda: cotEndSale – O evento(ação) ocorrerá após o pagamento e fechamento do cupom.
  • Menu venda fechada: CotClosedSaleMenu – O evento(ação) ocorrerá quando o caixa estiver aberto e a venda estiver fechada, ou seja, não pode haver uma venda em andamento.

A API PDV enviará um JSON informando em qual ciclo de operação atual o PDV se encontra, aguardando uma resposta para que alguma ação possa ser tomada de acordo com a solicitação do integrador(parceiro), ao voltar um ciclo de operação, as mensagens serão exibidas novamente, ficando a cargo do integrador, coordenar as mensagens através dos fluxos da API.

Fluxograma Principal

Imagem 1



    
Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil