Varejo Supermercados - Integrações - Parceiros - Integração com Cupom Verde – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:10:00 min

Dúvida
Como realizar a parametrização do TOTVS Varejo Supermercados PDV para integração com o parceiro Cupom Verde?

Ambiente
TOTVS Varejo - Supermercados PDV - Linha Consinco - Aplicável para todas as versões.

Pré-requisitos
Ter acesso ao Monitor Plus.
Ter acesso ao Monitor de PDVs.

Solução
Para realizar a integração do PDV com o Cupom Verde, é necessário:

Cadastrar o Código do Parceiro no Monitor Plus
Parametrizar a integração nos PDVs
Enviar as configurações para os PDVs
Validar o funcionamento da integração no PDV

Passo 1. Cadastre o código de parceiro, acesse:
Monitor Plus > Cadastro > Cadastro de parceiros.

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.

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

Passo 1.2. Definir o código do parceiro

Informe o código desejado.

Importante

Códigos menores que 1000 são reservados e definidos automaticamente pelo servidor.
Para integrações personalizadas, utilize códigos maiores ou iguais a 1000.

Passo 1.3. Informar descrição

Informe uma descrição para identificar a integração.

Passo 1.4. Descrição alternativa (opcional)

Este campo pode ser utilizado para uma identificação adicional, mas não é obrigatório.

Passo 1.5. Ativar o parceiro

No campo Ativo, selecione Sim.

Passo 1.6. Após preencher os campos, clique em Salvar.

Passo 2. Parametrizar os PDVs

Após cadastrar o parceiro, acesse o Monitor de PDVs.

Acesse as configurações do menu Vendas, no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações Externas > Vendas

Passo 2.1. O PDV permite até 8 integrações externas simultâneas.

Selecione uma das integrações disponíveis:

Integração 001
Integração 002
Integração 003
Integração 004
Integração 005
Integração 006
Integração 007
Integração 008

Neste exemplo será utilizada Integração 001.

Cada grupo representa uma integração distinta, permitindo que o PDV suporte até quatro integrações diferentes com sua API.

Passo 2.2. Informar o código do parceiro, no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Código do Parceiro

No campo Código do Parceiro, informe o código cadastrado no Monitor Plus.

Passo 2.3. Configurar autenticação (se aplicável), no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Autenticação

Algumas APIs exigem autenticação.

Caso o parceiro utilize autenticação, informe:

Usuário
Senha

Essas informações devem ser fornecidas pelo parceiro da integração.

Passo 2.4. Configurar os eventos de integração, no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Eventos

Os eventos determinam em quais momentos do PDV a API do parceiro será chamada.

Para a integração com Cupom Verde, normalmente são utilizados os eventos:

Cancelamento da Venda
Finalização da Venda

Passo 2.4.1. Evento: Cancelamento da venda - URL

Insira a URL do endpoint fornecido pela Cupom Verde, no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Eventos > Cancelamento da venda > URL

Passo 2.4.2. Evento: 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

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Eventos > Cancelamento da venda > Timeout

Passo 2.4.3. Evento: Finalização da venda - URL

Insira a URL do endpoint fornecido pela Cupom Verde, no caminho:

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Eventos > Finalização da venda > URL

Passo 2.4.4. Evento: Finalização 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

Monitor > Configurações > Configurações de PDV's > Integrações externas > Vendas > Integração 001 > Eventos > Finalização da venda > Timeout de leitura

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

Passo 3. Após realizar as parametrizações, envie as configurações para os PDVs.

Realize o envio das configurações para os PDVs desejados.

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

Compra registrada