Versões comparadas

Chave

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

...

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXXIntegrações externas
    1. Outras Ações / Ações relacionadas
  4. Tela XXXINtegrações externas
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

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 Cupom Verde.

02. EXEMPLO DE UTILIZAÇÃO

...

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

...

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 CADASTRE O CÓDIGO DE PARCEIRO

Dica:Este 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 AddedImage Removed
Imagem 1 - Logar na aplicação Monitor Plus
Image Removed
Imagem 2 - Acessar o cadastro de parceiros

Incluir


...

Clique no botão Incluir

...

e cadastre um novo código de parceiro

Image Modified
Imagem 3 - Incluir

Código

...


Defina a numeração correspontente 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 Modified
Imagem 4 - Código Parceiro

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

04. TELA XXXXX

Principais Campos e Parâmetros

...

Card documentos
InformacaoUse esse box para destacar informações relevantes e/ou de destaque.
TituloIMPORTANTE!


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

Image Added
Imagem 5 - Descrição da integração


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

Image AddedImagem 6 - Descrição alternativa


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

Image AddedImagem 7 - Ativar código do parceiro


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

Image AddedImagem 8 - 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 Added

Imagem 10 - Menu configurações


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

Imagem 11 - Integrações externas


Configurações / Configurações de PDVs / Integrações externas / Vendas

Acesse as configurações do menu Vendas.

Image AddedImagem 12 - Fluxo Vendas


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 13 - 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 14 - 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 15 - 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 16 - Eventos


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

Na integração com o sistema do parceiro Cupom Verde, será utilizado o evento Cancelamento da venda

Image AddedImagem 17 - Cancelamento da Venda


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

Insira a URL do endpoint fornecido pela Cupom Verde

Image AddedImagem 18 - URL


Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Cancelamento 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 19 - 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 Cupom Verde, será utilizado o evento Finalização da Venda

Image AddedImagem 20 - 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 Cupom Verde

Image AddedImagem 21 - 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 22 - Timeout de leitura


Salvar parametrização

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

Image AddedImagem 23 - Salvar


3) ENVIE AS CONFIGURAÇÕES PARA OS PDVS

Envie as configurações para os PDVs

Comunicações \ Comandos para PDVs.

Image AddedImagem 24 - Menu comunicações


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

Image AddedImagem 25 - Envio de configuração


4) FUNCIONAMENTO DO RECURSO NO PDV

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.


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.


Compra registrada


Image AddedImagem 26 - 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.

Image AddedImagem 27 - 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.

Image AddedImagem 28 - 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, a solicitação foi para uma impressão do cupom reduzido.

Image AddedImagem 29 - Cupom impresso


Processo concluído!

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á.