Histórico da Página

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.

1. Parametrização

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:

• Endereço Webservice PROTHEUS: Endereço do webservice utilizado para exportação de clientes, contas a receber e cancelamentos do PROTHEUS;
• Token: Token de autenticação do webservice PROTHEUS;
• Número máximo de tentativas de reenvio: Quantidade de vezes que um registro deve ser reenviado, em caso de erro.

1. Consulta - Pedidos VTEX

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.

1. Exportação de Contas a Receber para PROTHEUS

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:

• Empresa: Código da empresa PROTHEUS - Valor fixo 01;
• Filial: Código da filial - Valor fixo: 03DN0001;
• Data da Venda do Pedido;
• Forma de Pagamento: CC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX;
• ID VTEX: Código OrderID do pedido;
• Código do Cliente;
• Loja do Cliente;
• Pedido de Venda: Vazio;
• Número do Cartão: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
• Código da Autorização: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
• NSU: Quando utilizado os métodos de pagamento CC - Cartão de Crédito ou CD - Cartão de Débito;
• Nosso Número: Quando utilizado o método de pagamento BOL - Boleto Bancário;
• Código da Linha Digitável do Boleto Gerado: Quando utilizado o método de pagamento BOL - Boleto Bancário;
• Código TXID Transação PIX: Quando utilizado o método de pagamento PIX - Pagamento via PIX;
• Valor: Valor de cada parcela do pedido.

...

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.

1. Monitor de LOG

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:

• Id Log: Identificador sequencial de Log;
• Campos Chave: Descrição dos campos utilizados para gerar o registro integrado;
• Valores Chave: Chave primária do registro integrado;
• Status: Situação da Integração (Sucesso ou Erro);
• Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Dados);
• Data de Criação: Data de Criação do registro;
• Data da última alteração: Data da última alteração do registro;
• Número de tentativas de Reenvio: Quantidade de vezes que um registro já foi reenviado;
• Criador por: Usuário responsável pela inclusão do registro;
• Alterado Por: Usuário responsável pela alteração do registro;
• Módulo: Orquestrador VTEX.

• Id. Item Log: Identificador sequencial de log.;
• Id. Log: Identificador sequencial de log;
• Mensagem: Mensagem com o status da integração do item;
• Status: Situação da integração do item selecionado;
• Dados Enviados: Relação dos dados enviados para integração;
• Dados Recebidos: Relação dos dados recebidos;
• Data de Criação: Data de criação do registro;
• Data da Última Alteração: Data da última alteração do registro.

...

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:

• Empresa: Código da empresa PROTHEUS - Valor fixo 01;
• Filial: Código da filial - Valor fixo: 03DN0001;
• Data de Cancelamento do Pedido VTEX: A data de cancelamento será enviada no formato AAAAMMDD;
• Forma de Pagamento: CC - Cartão de Crédito / CD - Cartão de Débito / BOL - Boleto / PIX - Pagamento via PIX;
• Código da Ordem: Número do pedido;
• Código do Fornecedor: CPF/CNPJ vinculado ao pedido;
• Código do Banco: Banco vinculado a conta bancária do cliente para depósito/devolução;
• Código do Dígito Verificador da Agência: Agência correspondente à conta bancária do cliente para depósito/devolução;
• Código da Conta Bancária: Conta bancária correspondente à agência e banco do cliente para depósito/devolução;
• Código do Dígito Verificador da Conta Bancária: Dígito verificador correspondente à conta bancária do cliente para depósito/devolução;
• Valor: Valor de cada parcela do pedido.

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.