Histórico da Página
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Tela Integrações externas
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela INtegrações externas
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
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 Payface.
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 > Inicio da venda
Monitor > Configurações > Configurações de PDVS > Integrações externas > Vendas > Integração 001 (002, 003 ou 004) > Eventos > Pagamento 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 o Payface. 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 Payface, 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 Payface
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 Payface, 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 Payface
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 Payface, 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 Payface
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 / Pagamento da venda
Na integração com o sistema do parceiro Payface, será utilizado o evento Pagamento da venda
Imagem 26 - 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 Payface
Imagem 27 - 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 28 - 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 29 - 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 Payface, será utilizado o evento Subtotal da venda
Imagem 30 - 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 Payface
Imagem 31 - 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 32 - 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 Payface.
Imagem 33 - Pagamento automático
Salvar parametrização
Salve as parametrizações clicando no botão Salvar.
Imagem 34 - Salvar
3) ENVIE AS CONFIGURAÇÕES PARA OS PDVS
Envie as configurações para os PDVs
Comunicações \ Comandos para PDVs.
Imagem 35 - Menu comunicações
Selecione a loja ou PDV desejado, marque a opção Enviar configuração para o PDV.
Imagem 36 - Envio de configuração
4) FUNCIONAMENTO DO RECURSO NO PDV
A operação do recurso Payface 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 início de venda, cancelamento de venda, finalização de venda e pagamento de venda. 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á.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas