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 Cupom Verde.
Monitor Plus > Cadastro > Cadastro de parceiros
Monitor > Configurações > Configurações de PDVS > 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 > Finalização da venda
Ter acesso ao Monitor Plus;
Ter acesso ao Monitor de PDVs.
Nesta demonstração, abordaremos o cadastro do código do parceiro, o qual identificará a integração com o Cupom Verde. Além disso, apresentaremos todas as parametrizações necessárias para garantir o sucesso da integração.
1) CADASTRAR O CÓDIGO DE PARCEIRO
Dica: Este 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.
Imagem 1 - Acessar a aplicação Monitor Plus
Imagem 2 - Acessar o cadastro de parceiros
Incluir
Dica: Clicar no botão Incluir para cadastrar um novo código de parceiro
Imagem 3 - Incluir
Código
Dica: Definir a numeração correspontente ao código de parceiro desejado. Essa numeração só será permitida a personalização, se o códgio for igual ou maior que 1000.
Abaixo desse valor os códigos são definidos automaticamente pelo Servidor. Esse código será utilizado na paraemtrização dos PDVs.
Imagem 4 - Código Parceiro
Descrição
Dica: Definir uma descrição para identificar a integração parceira.
Imagem 5 - Descrição da integração
Descrição alternativa
Dica: Poderá definir uma descrição alternativa, caso deseje. Essa informação é opcional e não obrigatória.
Imagem 6 - Descrição alternativa
Ativo
Dica: Para ativar o código do parceiro, selecione a opção "Sim" no campo "Ativo".
Imagem 7 - Ativar código do parceiro
Salvar
Dica: Após preencher os campos de cadastro, clique no botão "Salvar".
Imagem 8 - Salvar cadastro
2) PARAMETRIZAÇÃO PDV
Dica: Após cadastrar o código do parceiro, acessar o Monitor de PDVs para realizar a parametrização dos PDVs para o funcionamento da integração.
Imagem 9 - Acessar Monitor de PDVs
Imagem 10 - Menu configurações
Integrações externas
Dica: Acessar as configurações de Integrações externas.
Imagem 11 - Integrações externas
Vendas
Dica: Acessar as configurações Vendas.
Imagem 12 - Fluxo Vendas
Integração 001 (002, 003 ou 004)
Dica: Para efetuar 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.
Imagem 13 - Integração
Código do Parceiro
Dica: Inserir o código do parceiro cadastrado anteriormente através do Monitor Plus.
Imagem 14 - Código do Parceiro
Autenticação
Dica: As configurações de autenticação são dependentes 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.
Imagem 15 - Autenticação API Parceiro
Eventos
Dica: Acesse e selecione o Evento do PDV no qual a API do Parceiro deverá interagir com nosso sistema de frente de caixa.
Imagem 16 - Eventos
Evento \ Finalização da venda
Dica: Na integração com o sistema do parceiro Cupom Verde, será utilizado o evento Finalização da Venda.
Imagem 17 - Finalização da venda
Evento \ Finalização da venda \ URL
Dica: Insira a URL do endpoint do parceiro. Essa URL corresponde ao caminho de comunicação da API externa e deve ser fornecida pelo parceiro.
Imagem 18 - URL
Evento \ Finalização da venda \ Timeout de leitura
Dica: Defina um valor de tempo de comunicação em milissegundos para a interação entre o PDV e a API do Parceiro.
Imagem 19 - Timeout de leitura
Salvar
Dica: Após definir os parâmetros clicar no botão “Salvar”.
Imagem 10 - Salvar
3) ENVIANDO CONFIGURAÇÕES PARA OS PDVS
Dica: Depois de ativar os parâmetros, é necessário enviar as configurações para os PDVs através do menu Comunicações \ Comandos para PDVs.
Imagem 21 - Menu comunicações
Selecione a loja ou PDV desejado e envie as configurações.
Imagem 22 - Envio de configuração
4) FUNCIONAMENTO DO RECURSO NO PDV
Dica: O funcionamento do recurso Cupom Verde 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 impressão completa, parcial ou não impressão do cupom de venda, assim como as mensagens exibidas na tela, são de responsabilidade do sistema Cupom Verde.
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.
Compra registrada
Imagem 23 - Venda
Finalização da compra / interação 1
Dica: Ao selecionar uma forma de pagamento e finalizar a compra, o PDV estabelece interação com a API do parceiro, que responde com a próxima instrução.
Neste exemplo, o parceiro poderá enviar uma pergunta ao consumidor.
Imagem 24 - Interação com API do Parceiro
Finalização da compra / Interação 2
Dica: Na interação seguinte, quando o consumidor responde "SIM", a API do Parceiro devolve a próxima instrução ao PDV.
Neste exemplo, o parceiro poderá solicitar a identificação do consumidor.
Imagem 25 - Interação com API do Parceiro
Finalização da compra / Interação 3
Dica: Após a indentificação na interação seguinte, a API do Parceiro devolve ao PDV qual tipo de cupom a ser impresso, ou seja, completo, parcial ou não impressão do cupom.
Neste exemplo, o parceiro solicitou a impressão do cupom reduzido.
Pronto, processo concluído!
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |
| Inclua o campo | Inclua a descrição relacionada |