Histórico da Página

...

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

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 - Acessar a aplicação Monitor PlusImage Removed
Imagem 2 - Acessar o cadastro de parceiros

Incluir

Dica: Clicar Clique no botão Incluir para cadastrar e cadastre um novo código de parceiro

Image Modified
Imagem 3 - Incluir

Código

Dica: Definir Defina a numeração correspontente ao código de parceiro desejado. Essa numeração só será permitida a personalização, se o códgio código 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. 

Image ModifiedImagem 4 - Código Parceiro

Descrição

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

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

Descrição alternativa

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

Image ModifiedImagem 6 - Descrição alternativa

Ativo

Dica: Para ativar Ative o código do parceiro, selecione selecionando a opção "Sim" no campo "Ativo".

Image ModifiedImagem 7 - Ativar código do parceiro

Salvar

Dica: Após preencher Preencha os campos de cadastro , e clique no botão "Salvar".

Image ModifiedImagem 8 - Salvar cadastro

2) PARAMETRIZAÇÃO PDVPARAMETRIZE OS PDVs

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

...

Configurações / Configurações de PDVs

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

Image RemovedImagem 11 - Integrações externas

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

Dica: Acessar Acesse as configurações do menu Vendas.

Imagem 12 - Fluxo Vendas

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

Dica: Para efetuar 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.

Imagem 13 - Integração

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

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

Imagem 14 - Código do Parceiro

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

Dica:As configurações de autenticação são dependentes 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.

Imagem 15 - Autenticação API Parceiro

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

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

Imagem 16 - Eventos

...

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

Dica:Na integração com o sistema do parceiro Cupom Verde, será utilizado o evento Finalização Cancelamento da Venda.venda

Image RemovedImage AddedImagem 17 - Finalização Cancelamento da venda

Evento \ Finalização da venda \ URL

Venda

Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Cancelamento 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.

Image RemovedImagem 18 - URL

Evento \ Finalização da venda \ Timeout de leitura

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

Salvar parametrização

Salve as parametrizações clicando Dica: Após definir os parâmetros clicar no botão “Salvar” Salvar.

Imagem 10 23 - Salvar

3) ENVIANDO ENVIE AS CONFIGURAÇÕES PARA OS PDVS

Dica:Depois de ativar os parâmetros, é necessário enviar Envie as configurações para os PDVs através do menu

Comunicações \ Comandos para PDVs.

Imagem 21 24 - Menu comunicações

Selecione a loja ou PDV desejado e envie as configurações, marque a opção Enviar configuração para o PDV.

Imagem 22 25 - 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.

Compra registrada

Imagem 23 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.

Imagem 24 27 - Interação com API do Parceiro

...

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 28 - Interação com API do Parceiro

...

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

Image ModifiedImagem 29 - Cupom impresso

Processo Pronto, processo concluído!

03. TELA

...

INTEGRAÇÕES EXTERNAS

Outras Ações / Ações relacionadas

...

Não há.

...

04.

...

TELA

...

Principais Campos e Parâmetros

...

INTEGRAÇÕES EXTERNAS

Outras Ações / Ações relacionadas

Não há.

05. TABELAS UTILIZADAS

Não há.