Parametrização do PDV para integração com IdEver

CONTEÚDO

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

01. VISÃO GERAL

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

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

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

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

Monitor > Configurações > Configurações de PDVS > Integrações externas > Vendas > Integração 001 (002, 003 ou 004) > Eventos > Subtotal 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 Idever. 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.

Imagem 1 - Acessar o cadastro de parceiros

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

Imagem 3 - Incluir

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. 

Imagem 4 - Código Parceiro

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

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

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

Imagem 6 - Descrição alternativa

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

Imagem 7 - Ativar código do parceiro

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

Imagem 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

Imagem 10 - Menu configurações

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

Imagem 11 - Integrações externas

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

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)

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

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

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.

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

Imagem 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 IdEver, será utilizado o evento Cancelamento da venda

Imagem 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 IdEver

Imagem 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

Imagem 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 IdEver, será utilizado o evento Finalização da Venda

Imagem 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 IdEver

Imagem 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

Imagem 22 - Timeout de leitura

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 IdEver, será utilizado o evento Início da venda

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

Imagem 24 - URL

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

Imagem 25 - Timeout de leitura

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

Na integração com o sistema do parceiro IdEver, será utilizado o evento Menu venda aberta

Imagem 26 - Menu venda aberta

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

Insira a URL do endpoint fornecido pela IdEver

Imagem 27 - URL

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

Imagem 28 - Timeout de leitura

Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Menu venda aberta / Descrição do menu

Insira uma descrição desejada para nomear o Menu no PDV

Imagem 29 - Descrição do menu

Cadastros / Usuários e grupos / Permissões /  AcruxPDV

Para utlização do Menu venda aberta, é obrigatório liberar as permissões para o Grupo ou Usuário e enviar para os PDVs
Antes o menu de permissões, salvar as configurações anteriores.

Imagem 30 - Permissões

Comunicações / Comandos para PDVs / Enviar permissões para o PDV

Enviar permissões para os PDVs.

Imagem 31 - Enviar permissões

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

Na integração com o sistema do parceiro IdEver, será utilizado o evento Pagamento da venda

Imagem 32 - Pagamento da venda

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

Insira a URL do endpoint fornecido pela IdEver

Imagem 33 - URL

Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Pagamento da venda / Número da forma de pagamento

Insira o número da forma de pagamento que será utilizada pelo Parceiro. Importante informar que o cadastro da forma de pagamento deve seguir os padrões de cadastro do ERP e a espécie utilizada deve ser do tipo Outros.
O cadastro deve ser realizado pelo cliente (supermercado) e o código de cadastro fornecido pelo mesmo.

Imagem 34 - Forma de pagamento

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

Imagem 35 - 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 IdEver, será utilizado o evento Subtotal da venda

Imagem 36 - 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 IdEver

Imagem 37 - 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

Imagem 38 - Timeout de leitura

Configurações / Configurações de PDVs / Integrações externas / Vendas / Integração 001 / Eventos / Subtotal da venda / Pagamento automático

O processo de pagamento automático não é utilizado na integração do parceiro IdEver.

Imagem 39 - Pagamento automático

Salvar parametrização

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

Imagem 40 - Salvar

3) ENVIE AS CONFIGURAÇÕES PARA OS PDVS

Envie as configurações para os PDVs

Comunicações \ Comandos para PDVs.

Imagem 41 - Menu comunicações

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

Imagem 42 - Envio de configuração

4) FUNCIONAMENTO DO RECURSO NO PDV

A operação do recurso IdEver está completamente vinculada ao sistema do parceiro, uma vez que o ponto de venda (PDV) enviará constantemente requisições à API externa, aguardando as respectivas respostas para execução de ações específicas. Nesse processo de integração, o parceiro utiliza vários eventos, tais como identificação de cliente, aplicação de descontos, cashback, troco, finalização da venda, consultas através de menu, entre outros. Dada a complexidade dessa integração, o funcionamento no PDV não foi detalhadamente exemplificado nesta documentação.

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