Manual Operacional da Customização - Integração VTEX: Orquestrador DN
Objetivo
Este documento foi elaborado para orientar aos usuários-chave do SENAI DN sobre os requisitos e funcionalidades do Orquestrador, customização aplicada ao TOTVS Educacional (SGE) que atua na integração entre o PROTHEUS e a Plataforma VTEX. A partir da leitura dos dados das vendas/pedidos realizados pela plataforma VTEX, o Orquestrador envia as informações para as API 's do PROTHEUS SENAI DN retornando o status da integração à plataforma VTEX.
Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave para o Template Digital, SENAI DN.
Metodologia
Este material tem como base a visão prática e completa do Processo Customizado, da área Educacional através da Customização existente - FS008696 - Integração VTEX - Orquestrador.
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional (SGE). Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.
Expandir | ||
---|---|---|
| ||
Liberação dos anexos customizados na árvore de perfil: |
A parametrização da customização da API PROTHEUS deverá ser realizada de modo que sejam configurados os parâmetros customizados para informação do endereço e dados de acesso para as API's do PROTHEUS, disponível em: TOTVS Educacional | Customização l Orquestrador VTEX l Parâmetros.
Na interface, os parâmetros processam a autenticação BASIC nas API's de exportação do PROTHEUS, para os quais o usuário deverá efetuar as seguintes parametrizações:
A consulta das APIS de pagamentos provenientes da plataforma VTEX identifica as informações referentes às inscrições associadas a vendas realizadas/canceladas (Escopo Informações Financeiras do VTEX - FS008537) para envio ao PROTHEUS SENAI DN.
Importante: A tabela deverá também considerar os seguintes dados já existentes na plataforma VTEX:
...
Observação: A customização irá verificar os itens do pedido, visto que, podem existir clientes diferentes para cada item de um mesmo pedido. O item do pedido não tem relação somente com o produto comprado, mas também com o cliente tipo: Seller.
O processo de exportação de contas a receber para o PROTHEUS envia as informações financeiras associadas aos pedidos realizados na plataforma VTEX, com status: "ready-for-handling (Pronto para manuseio)".
A partir da verificação do Item de Pedido, a customização irá identificar os itens pagos no mesmo para envio a API, através do método de recebimentos (HTTP POST), onde serão enviados os dados da transação, valores e parcelas que compõem o pedido, tais como:
...
Através da consulta ao Monitor de Log, será possível consultar o status da movimentação do pedido.
Verificado o envio com sucesso de contas a receber dos pedidos/vendas realizados na plataforma VTEX à API PROTHEUS, a customização retornará uma atualização à plataforma VTEX para que o pedido seja movimentado. A partir desta atualização, o pedido terá o status: Pronto para Manuseio alterado para: Faturado.
O Monitor de Log, disponível em: TOTVS Educacional | Sistema Indústria | Orquestrador VTEX | Monitor de Log, armazena os dados exportados dos registros relacionados à Integração VTEX, possibilitando o acompanhamento e identificação dos registros exportados e importados com sucesso ou que necessitam ser reenviados.
Ao clicar sobre um registro de log, o usuário poderá consultar as demais informações complementares associadas ao registro, tais como:
...
A partir da necessidade de atualização do processo de consulta de pagamentos VTEX é possível identificar pedidos com status: Cancelado.
Uma vez identificado, será verificado se este pedido foi exportado ao PROTHEUS em algum momento com status: Integrado com sucesso.
Para registros que já tenham sido exportados com status: Integrado com sucesso, a API Pagamentos Incluir PROTHEUS será acionada, enviando as seguintes informações:
Observação: Para registros não localizados com status: Integrado com sucesso, ou seja, que não foram exportados com status, a API Pagamentos Incluir PROTHEUS será acionada, realizando a exportação do cliente e contas a receber, aplicando um registro ao monitor de vendas e, em seguida, acionando a API para inclusão de pagamento.