Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações

Esta documentação tem como propósito orientar todos os públicos sobre como realizar a parametrização do sistema Totvs Varejo Supermercados PDV para a integração com o sistema parceiro Bnex.


02. EXEMPLO DE UTILIZAÇÃO

Caminho

Monitor Plus > Cadastro > Cadastro de parceiros

Monitor > Configurações > Configurações dePDVS > Integrações externas > Vendas

Monitor > Configurações > Configurações de PDVS > Integrações externas > Vendas > Integração 001 (002, 003 ou 004)

Monitor > Configurações > Configurações de PDVS > Integrações externas > Vendas > Integração 001 (002, 003 ou 004) > Eventos > Cancelamento da venda

Monitor > Configurações > Configurações de PDVS > Integrações externas > Vendas > Integração 001 (002, 003 ou 004) > Eventos > Finalização da venda

Pré-requisitos e Instruções

Ter acesso ao Monitor Plus;
Ter acesso ao Monitor de PDVs.

Passo a Passo

Nesta demonstração, abordaremos o cadastro do código do parceiro, o qual identificará a integração com a Benex. Além disso, apresentaremos todas as parametrizações necessárias para garantir o sucesso da integração.


1) CADASTRE O CÓDIGO DE PARCEIRO

O código faz parte do fluxo de integração da API do PDV e tem a finalidade de identificar cada integração de sistemas terceiros com nosso sistema de frente de caixa.

Image Added             Imagem 1 - Acessar o cadastro de parceiros



Clique no botão Incluir e cadastre um novo código de parceiro

Image AddedImagem 2 - Incluir



Defina a numeração correspondente ao código de parceiro desejado. Essa numeração só será permitida a personalização, se o código for igual ou maior que 1000.
Abaixo desse valor os códigos são definidos automaticamente pelo Servidor. 

Image AddedImagem 3 - Código Parceiro



Defina uma descrição para identificar a integração parceira.

Image AddedImagem 4 - Descrição da integração



Defina uma descrição alternativa, caso deseje. Essa informação é opcional e não obrigatória.

Image AddedImagem 5 - Descrição alternativa



Ative o código do parceiro, selecionando a opção Sim no campo Ativo.

Image AddedImagem 6 - Ativar código do parceiro



Preencha os campos de cadastro e clique no botão Salvar.

Image AddedImagem 7 - Salvar cadastro


2) PARAMETRIZE OS PDVs

Após o cadastro o código do parceiro, acesse o Monitor de PDVs e realize a parametrização dos PDVs para o funcionamento da integração.

Configurações / Configurações de PDVs

Image AddedImagem 9 - Menu configurações



Configurações / Configurações de PDVs / Integrações externas
Acesse as configurações do menu Integrações externas.
Image Added

Imagem 10 - Menu configurações - Integrações externas

Configurações / Configurações de PDVs / Integrações externas / Vendas
Acesse as configurações do menu Vendas.


Image Added
Imagem 11 - Menu configurações - Integrações externas/Fluxo de venda


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 (002, 003 ou 004)

Efetue as configurações da integração, escolha e acesse um dos quatro grupos disponíveis (neste exemplo, utilizaremos a integração 001).
Cada grupo representa uma integração distinta, permitindo que o PDV suporte até quatro integrações diferentes com sua API.

Image AddedImagem 12 - Menu configurações - Integrações externas/Integração


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Código do Parceiro

Insira o código do parceiro cadastrado anteriormente através do Monitor Plus.

Image AddedImagem 13 - Menu configurações - Integrações externas/Código do parceiro


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Autenticação

As configurações de autenticação depende da empresa parceira. Ou seja, caso a API externa exija autenticação por meio de usuário e senha, essa informação deverá ser disponibilizada pelo parceiro.
Embora não seja obrigatório que o parceiro tenha autenticação em sua API, caso ela exista, é essencial realizar a parametrização no PDV.

Image AddedImagem 14 - Menu configurações - Integrações externas/Autenticação API Parceiro


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos

Acesse e selecione o Evento do PDV no qual a API do Parceiro interagirá com o sistema de frente de caixa.

Image AddedImagem 14 - Menu configurações - Integrações externas/Eventos


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Início da venda
Na integração com o sistema do parceiro Bnex, será utilizado o evento Início da venda

Image AddedImagem 15 - Menu configurações - Integrações externas/Eventos/Início da venda


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Início da venda / URL
Insira a URL do endpoint fornecido pela Bnex

Image AddedImagem 16 - Menu configurações - Integrações externas/Eventos/Início da venda/URL


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Início da venda / Timeout

Insira o valor de tempo de comunicação em milissegundos para a interação entre o PDV e a API do Parceiro

Image AddedImagem 17 - Menu configurações - Integrações externas/Eventos/Início da venda/Timeout de leitura


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Subtotal da venda
Na integração com o sistema do parceiro Bnex, será utilizado o evento Subtotal da Venda

Image AddedImagem 18 - Menu configurações - Integrações externas/Eventos/Subtotal da venda


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Subtotal da venda / URL

Insira a URL do endpoint fornecido pela Bnex


Image AddedImagem 19 - Menu configurações - Integrações externas/Eventos/Subtotal da venda/URL


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Subtotal da venda / Timeout de leitura
Insira o valor de tempo de comunicação em milissegundos para a interação entre o PDV e a API do Parceiro

Image AddedImagem 20 - Menu configurações - Integrações externas/Eventos/Subtotal da venda/Timeout de leitura



Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Finalização da venda
Na integração com o sistema do parceiro Bnex, será utilizado o evento Finalização da Venda

Image AddedImagem 21 - Menu configurações - Integrações externas/Eventos/Finalização da venda


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Finalização da venda / URL
Insira a URL do endpoint fornecido pela Bnex

Image AddedImagem 22 - Menu configurações - Integrações externas/Eventos/Finalização da venda/URL


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Finalização da venda / Timeout de leitura

Insira o valor de tempo de comunicação em milissegundos para a interação entre o PDV e a API do Parceiro

Image AddedImagem 23 - Menu configurações - Integrações externas/Eventos/Finalização da venda/Timeout de leitura


Salvar parametrização

Salve as parametrizações clicando no botão Salvar.

Image AddedImagem 24 - Menu configurações - Integrações externas/Salvar parametrizações


3) ENVIE AS CONFIGURAÇÕES PARA OS PDVS

Envie as configurações para os PDVs

Comunicações \ Comandos para PDVs.

Image AddedImagem 25 - Menu Comunicações/ Comandos para PDVs



Selecione a loja ou PDV desejado, marque a opção Enviar configuração para o PDV.

Image AddedImagem 26 - Menu Comunicações/ Comandos para PDVs/ Enviar configurações para PDV


4) FUNCIONAMENTO DO RECURSO NO PDV

O funcionamento do recurso Bnex depende integralmente do sistema do parceiro, pois o PDV sempre enviará requisições à API externa e aguardará as respostas sobre o que fazer. Em outras palavras, nesse cenário, a aplicação dos descontos na venda, são de responsabilidade do sistema Bnex.

Informações

As próximas imagens que veremos abaixo são meramente ilustrativas e simuladas em ambiente interno, utilizadas apenas para fins de exemplificação e não correspondem às interações oficiais do parceiro.


Registando produto

Início da venda / interação 1

Dica: Neste caso, o PDV estabelece interação com a API no início da venda, onde o parceiro responde com a próxima instrução.
Neste exemplo, o parceiro poderá enviar uma pergunta ao operador do PDV, se o cliente possui fidelidade com o estabelecimento, para que o desconto possa ser aplicado de acordo com as regras oferecidas pelo próprio parceiro.
Dependendo da resposta o parceiro poderá solicitar outras informações ao consumidor, como por exemplo o CPF, ou simplesmente notificar ao PDV para continuar com a operação de venda.

Image AddedImagem 27 - Em interação com a API

Após confirmação do parceiro para o PDV continuar a venda o produto é registrado

Image AddedImagem 28 - Produto registrado no PDV


Na etap de subtotal da venda, o parceiro valida as informações retornadas pela API do PDV e aplica, ou não, os descontos.

Image AddedImagem 29 - Cupom sendo validado pelo parceiro para aplicar ou não desconto


Caso o cliente e a compra esteja elegível, o desconto será aplicado

Image AddedImagem 30 - Desconto aplicado pelo parceiro


03. TELA INTEGRAÇÕES EXTERNAS

Outras Ações / Ações relacionadas

Não há.


04. TELA INTEGRAÇÕES EXTERNAS

Outras Ações / Ações relacionadas

Não há.

05. TABELAS UTILIZADAS

Não há.