Projeto: FS008599 - Integração TOTVS Educacional x  VTEX

Nome do Cliente: Confederação Nacional da Indústria - SENAI


O objetivo deste projeto é realizar a integração dos Cursos e Turmas disponíveis no TOTVS Educacional SGE para realização de compras na plataforma VTEX.
Após a compra,  será retornado pelo VTEX através de URL, os dados inseridos na compra para que a inscrição/matrícula do candidato seja incluída no TOTVS Educacional (SGE). Para garantir uma experiência única para o usuário, a página nativa de inscrição do Processo Seletivo foi ajustada, para que o layout apresentado esteja com as cores e design do SENAI. A página permanece com os serviços nativos e exibirá  ao candidato todos os campos parametrizados no Processo Seletivo.
Após a inscrição/ Matrícula, a customização retornará ao VTEX, através de chamada de API, o status de matrícula do aluno para que seja apresentado na área do cliente após a compra.
Todas as regras para realização da matrícula existentes no escopo FS008228 (A50.301) – Integração MarketPlace não serão alteradas.


A integração acontece para vendas B2C e B2B:

B2C: Do termo em inglês “Business to Consumer”, que significa “negócios para consumidores”. Aqui, as vendas são direcionadas para pessoas físicas.

B2B: Do termo em inglês “Business to Business”, que significa “negócios para negócios”. Aqui, as vendas são direcionadas para pessoas Jurídicas é o tipo de empresa que vende para outras empresas. 


O escopo conta com o complemento de projetos adicionais que podem ser acessados nos manuais abaixo:


O fluxo abaixo segue a regra geral do integração.

O fluxo acima pode divergir devido as customizações financeiras específicas de cada regional.

Será necessário informar alguns dados para possibilitar a Integração com a Plataforma VTEX. Para isso, formam desenvolvidos parâmetros customizados. A interface estará disponível em: TOTVS Educacional | Sistema Industria | Integração VTEX | Parâmetros.


  • Aba: Dados Integração - Produto/SKU

Nesta aba são parametrizados os dados de conta específicos para o processo de exportação de Produto/SKU na VTEX (Cursos e Turmas). Esses dados são únicos e valem para todos os regionais.


  • Aba: Dados Integração Geral

Nesta aba são parametrizados os dados de conta específicos de cada regional para realizar as demais funcionalidades na VTEX, como por exemplo: Consulta de Pedidos, Preço, Estoque etc.. 


  • Aba: Parâmetros Gerais

Nesta aba o usuário deverá parametrizar o número máximo de tentativas de reenvio para itens com erros no monitor de log.


  • Aba: Dados Financeiros

Nesta aba serão definidos o código da forma de pagamento que será utilizada no processamento de baixa automática (FS008537 - Integração VTEX - Informações Financeiras).  Esse cadastro é realizado por Filial.

Maiores informações sobre essa aba no Manual Integração VTEX - Informações Financeiras.


  • Aba: E-mail

Nesta aba é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio automático de e-mail (para o responsável do curso) , nos casos em que o número de vagas disponíveis para a oferta de curso tenha se esgotado e existam candidatos/inscritos com pendência de matrícula ((FS008537 - Integração VTEX - Informações Financeiras).


O SGE não garante o recebimento do e-mail, já que não é possível saber se o endereço do destinatário existe ou se a caixa está cheia, impedindo o recebimento. Será possível mapear apenas o envio.

Maiores informações sobre essa aba no Manual Integração VTEX - Informações Financeiras.

Além das parametrizações citadas anteriormente neste documento, para Oferta para Empresas é necessário informar dados específicos  para possibilitar a Integração com a Plataforma VTEX. Para isso, formam desenvolvidos parâmetros customizados.

A interface estará disponível em: TOTVS Educacional | Sistema Industria | Integração VTEX |Parâmetros.

  • Aba: Dados Integração - Produto/SKU

Nesta aba são parametrizados os dados de conta específicos para o processo de exportação de Produto/SKU na VTEX (Cursos e Turmas). Esses dados são únicos e valem para todos os regionais.

image2022-9-6_11-31-12.png

  • Aba: Dados Integração Geral

Nesta aba são parametrizados os dados de conta específicos de cada regional para realizar as demais funcionalidades na VTEX, como por exemplo: Consulta de Pedidos, Preço, Estoque etc..

  • Aba: E-mail B2B

Nesta aba é possível parametrizar todos os dados necessários para o usuário definir um textão padrão do envio de e-mail de confirmação de compra de cursos exclusivos B2B (para empresas).

image2022-9-6_11-33-1.png

Para Processos Seletivos de cursos exclusivos para Empresas (B2B) é necessário informar que a Oferta é exclusiva  B2B, conforme imagem abaixo.

Lembrando que, esse parâmetro define que os cursos serão exportados apenas para a loja B2B. Processos seletivos que não estejam com o parâmetro marcado, são enviados de forma padrão para as duas lojas: B2B e B2C.

image2022-9-6_11-11-18.png


Tanto para Processo Seletivos para pessoa física ou para pessoa Jurídica, para que o campo fiquei parametrizado é necessário marcar primeiramente o campo: Utiliza venda online de cursos e Oferta VTEX.

Foi criada uma interface para possibilitar que o usuário realize as correlações (DE I PARA) entre o TOTVS Educacional e VTEX.

A interface está disponível no Menu: TOTVS Educacional | Sistema Industria | Integração VTEX | De I Para Integração VTEX

No Menu terá três abas para  que o usuário realize a correlação de cada uma, sendo elas: Modalidade, Área e Filial.

Dentro de cada aba terá o processo para registro do DE I PARA:


  • DE I PARA Modalidade e Área

Ao executar o processo na tela de cadastro do De I Para, o usuário deverá selecionar, na grid do lado esquerdo, a Modalidade ou Área do VTEX que será parametrizada. E do lado direito, as modalidades e áreas correspondentes no SGE, conforme demonstração abaixo:


O SENAI DN contratou um script padrão para cadastro de algumas modalidades e áreas. Ao instalar a customização, essa tela será preenchida com alguns registros templates. O regional poderá editar e/ou inserir novos registros.


  • DE I PARA Filial

Ao executar o processo na tela de cadastro do De I Para, o usuário deverá selecionar, na grid a esquerda, a Unidade do VTEX que será parametrizada, e na grid da direita, a Filial do SGE, conforme demonstração abaixo:


Foi criado na interface de Turmas, um processo que possibilita o usuário parametrizar quais dias da semana as turmas no SGE terão aulas na sua programação.

O Processo Customizado, está disponível em: TOTVS Educacional | Currículo e Oferta | Turmas | Processo para alocação de Turmas. 

O processo poderá ser executado para uma ou mais Turmas em cada execução.


Ao executar o processo, o usuário deverá selecionar os dias da semana que serão consideramos na alocação de turmas (dias da semana nos quais terão aulas), conforme imagem abaixo. As informações do processo serão gravadas no anexo Disponibilidade Semanal, descrito abaixo.


Se o processo for executado para dias da semana onde já existam registros inseridos no anexo por uma execução anterior, os registros anteriores serão preservados e não sofrerão quaisquer alterações. Somente serão inseridos dias da semana que ainda não estejam disponíveis no anexo.

O anexo Disponibilidade Semanal, permite ao usuário a visualização da relação de dias da semana para aulas de determinada turma (definida no processo citado acima). 

Encontra-se disponível na tela nativa de Turmas: TOTVS Educacional | Currículo e Oferta | Turmas | Anexo | Disponibilidade Semanal. As informações são armazenadas por Coligada, Filial e Nível de Ensino.

A visualização na tela do anexo será do texto completo na descrição do dia da semana, sem abreviações. Os dias disponíveis serão exibidos em linhas separadas conforme exemplo abaixo:

O anexo está disponível apenas para visualização e exclusão, as inclusões serão feitas exclusivamente pelo processo. 

Ao criar um Processo Seletivo que utilizará integração Vtex é necessário informar os seguintes parâmetros:

  • Utiliza Oferta Vtex

Marcar a flag indicando que o processo seletivo utilizará integração com o Vtex. O campo está disponível na aba Identificação do Processo Seletivo:

Tanto para Processo Seletivos para pessoa física ou para pessoa Jurídica, para que o campo fiquei parametrizado é necessário marcar primeiramente o campo: Utiliza venda online de cursos.


  • Criação das  Áreas de Interesse Ofertadas

Após a criação do Processo Seletivo será necessário vincular as Áreas de Interesse Ofertadas. Esses registros serão exportados e darão origem aos cursos que o usuário poderá comprar no VTEX.

  • Turmas da Área de Interesse

Após a criação do Processo Seletivo e da Área Ofertada, será necessário preencher o anexo Turmas da Área de Interesse.

As Turmas cadastradas nessa tela serão exportadas como um SKU para a VTEX, ou seja, serão as opções de compras dentro dos cursos na plataforma.


  • Anexo Dados Integração VTEX

Em seguida, deverá ser parametrizado o anexo  Dados Integração VTEX, que está disponível na tela do cadastro do Processo Seletivo.


A tela de cadastro dos Dados VTEX, contém 3 abas:

Dados do curso: onde deve ser informado o valor do Curso e a Descrição Curso Google.


Dados Adicionais: Nesta aba o usuário poderá incluir informações adicionais, as Empresas que indicam e os Parceiros.

Mídias Digitais: Nesta aba o usuário informa as URLs que correspondem a imagem, vídeo e degustação do curso, que serão enviadas para a Plataforma VTEX.
Atenção para a URL imagem, que é de envio obrigatório nesta integração e deverá estar pública.

  • Anexo Dados Integração VTEX - Áreas Ofertadas

Devemos também vincular as áreas ofertadas que irão utilizar os dados desse anexo, através do anexo Áreas Ofertadas.  Será exibido no filtro para seleção, todas as áreas de interesse cadastradas no processo seletivo utilizado.

O anexo e os dados parametrizados serão exibidos para todas as filiais existentes na coligada, independentemente se o parâmetro nativo ‘Visível para todas as filiais’ estiver marcado. A mesma área de interesse poderá ser vinculada apenas uma vez por PS. Caso o processo seletivo seja parametrizado para utilizar em várias filiais, o registro do anexo será compartilhado entre as filiais, visto que, esses dados refletem em um card e produto único na VTEX.

Será possível inserir uma área ofertada para apenas UM registro de dados integração VTEX, caso o usuário tente inserir a mesma área de interesse para mais de um registro, será exibido a mensagem abaixo impedindo salvar o registro.


Ao salvar o processo seletivo será validado se existe alguma área de interesse vinculada ao Processo Seletivo que não esteja relacionada a um registro de dados integração VTEX. Caso seja identificado, será exibido a mensagem de alerta ao usuário.


  • Anexo Dados Integração VTEX - Tipo de Financiamento

Deverá ser vinculado também os dados do Tipo de Financiamento que será utilizado. Será exibido no filtro para seleção a lista da tabela dinâmica (TIPOGRAT) já existente, disponibilizada e utilizada no template do SGE.




Segue configurações necessárias para que Produto (Curso) e SKU (Turma) sejam criado na VTEX:

Após finalizados todas as parametrizações e cadastros, o usuário deverá executar o processo de exportação de dados. Através desse processo que os Produtos e SKUs serão criados na VTEX.

O processo pode ser agendado ou executado através do Menu: TOTVS Educacional | Sistema Industria | Integração VTEX | Exportar Dados


O processo fará a exportação de todos os Produtos e SKUs sendo da política comercial B2B e/ou B2C.

Para os cursos exclusivos B2B, onde o novo parâmetro (Oferta Exclusiva B2B) do processo seletivo estiver marcado, será enviada a informação política comercial B2B (na área VTEX : Para empresas) e seu preço específico. Esse parâmetro define que os cursos serão exportados apenas para a loja B2B. Processos seletivos que não estejam com o parâmetro marcado, são enviados de forma padrão para as duas lojas: B2B e B2C.

Abaixo exemplos de visualização dos campos no SGE e na VTEX.

  • Nome do Curso:


  • Modalidade (Categoria do Curso):

  • Descrição Principal do Curso:


  • Área (Subcategoria do Curso):


  • Matriz Curricular: Presencial/ Semipresencial/ À Distância


  • Matriz Curricular: Carga horária


  • Matriz Curricular: Informações do Curso

  • Turma e Turma Disciplina: Data Inicial e Final


  • Turma e Turma Disciplina: Dias da Semana


  • Turma e Turma Disciplina: Turno

É considerado sempre a Turma Disciplina de menor IDTURMADISC.


  • Turma e Turma Disciplina: Período de Matrícula

É considerado sempre a Turma Disciplina de menor IDTURMADISC.

Caso o período de matrícula no Portal, do cadastro da Turma/Disciplina estiver em branco, será enviado o período de inscrição do Processo Seletivo. Conforme modelo abaixo.

  • Processo Seletivo: Período das Inscrições

  • Plano de pagamento:

- A regra de parcelamento é configurado diretamente na loja VTEX e será responsabilidade de cada regional.

  • Plano de pagamento vinculado no Processo Seletivo:

- Para cursos gratuitos deverão ser vinculados planos de pagamentos sem parcelas. A customização irá validar se o plano não possui parcelas e o curso será considerado gratuito, com isso, será enviado o preço de R$0,01 ao VTEX.

- Para processos seletivos VTEX, não será permitido o vínculo de planos de pagamento que possuam mais de uma parcela. Caso o usuário tente adicionar, será exibido uma mensagem na tela ao salvar o registro de área de interesse.

  • Processo Seletivo Anexo - Dados de Integração VTEX:

Valor do Curso


  Descrição Curso Google:


Informações Adicionais / Empresas que indicam / Parceiros:

URL da Imagem:

URL do Vídeo:


URL da Degustação do Curso:

  • Cadastro da Filial



  • Texto Fixo:

Após finalizado a exportação de dados, quando os Produtos (Cursos) e SKUs (Turmas) já estiverem disponíveis na plataforma VTEX; o cliente/aluno poderá acessar a página para realizar sua compra.

Abaixo um passo a passo do fluxo de compra / matrícula do VTEX.

Iniciado pela seleção do Produto (Curso):

É necessário informar o estado ofertante do Curso e adicionar o produto ao carrinho de compras:

Para cursos pagos, após a identificação dados pessoais do aluno/cliente e o pagamento realizado, será disponibilizado o acesso a Matrícula, conforme imagem abaixo:

Ao clicar em realizar matrícula, o usuário será redirecionado para a tela de cadastro do Processo Seletivo, que foi customizada para manter a mesma identidade visual do Mundo Senai. Os dados de cadastro do aluno, assim como opção do curso já virão preenchidos da VTEX. As configurações e processamentos da inscrição/matrícula continuarão a ser executados através dos serviços nativos, seguindo as regras já existentes no projeto FS008228 (A50.301) – Integração MarketPlace.

A página final do processo nativo de inscrição/ matrícula do portal do Processo Seletivo foi customizada para ocultar as informações de pagamento, visto que, o pagamento já foi feito na plataforma VTEX. Sendo elas:

- Texto ‘Matrícula aguardando pagamento para efetivação. Utilize as opções abaixo para realizar o pagamento da matrícula’;
- Botão 'Pagamento com cartão de crédito'.



Central do Candidato:

- Pagamento: Texto ‘Matrícula aguardando pagamento para efetivação’;
- Data de vencimento da parcela;
- Botão 'Pagamento com cartão de crédito'.


As informações sobre a realização da compra, geração e baixa de lançamento financeiro com base nas informações de venda e pagamento, estão detalhadas no Manual - Integração VTEX Informações financeiras. Para acessa-lo, clique aqui.

O processo de Consulta de Pagamentos VTEX, busca as informações de vendas de pedidos realizados pela loja, armazena os dados no Monitor de vendas (e cria o cadastro do Cliente/Fornecedor, com os dados do comprador do pedido.

Um destaque para o campo Canal de venda, onde será informado se a oferta é B2B ou B2C:



A descrição de todo o Processo Financeiro está  no Manual Integração VTEX - Informações Financeiras.

Processo customizado para envio ou reenvio de e-mail de confirmação de compras de cursos exclusivos para empresa (B2B) para o cliente, com opção de informar outros e-mails alternativos como destinatário. O usuário deverá selecionar um item do Pedido VTEX para a execução do processo.

O processo está disponível da tela do Monitor de vendas: TOTVS Educacional, menu Sistema Indústria | Integração VTEX | Monitor de Vendas | Processos | Envio de E-mail

Ao acessar será exibida interface com uma caixa de texto, onde o usuário informará a lista de destinatários para os quais deseja enviar o e-mail de confirmação de compra.


O SGE não garante o recebimento do e-mail, já que não é possível saber se o endereço do destinatário existe ou se a caixa está cheia, impedindo o recebimento. Será possível mapear apenas o envio.

Ao clicar em realizar matrícula (descrito acima), o usuário é direcionado para a tela de cadastro do Processo Seletivo. As configurações e processamentos da inscrição/matrícula continuarão a ser executados através dos serviços nativos do produto educacional.

Os dados de cadastro do Aluno, assim como opção do Curso já virão preenchidos da VTEX.


A página do Processo Seletivo foi customizada, sendo assim, ela seguirá os padrões de cores, fontes e estilos existentes atualmente na plataforma VTEX.

Assim como acontece com o produto nativo, as inscrições/matriculas feitas pelo Processo Seletivo, são registradas no SGE.  Além das informações referentes a matrícula, na tela de cadastro do Cursos/Habilitações, estarão disponíveis os dados referentes a Cupom, Percentual de Desconto e Valor final do curso. 


Quando uma matrícula é realizada, a plataforma VTEX entende que esse Pedido foi entregue, alterando seu status, conforme imagem abaixo:


O processo de matrícula do aluno para os cursos B2B será realizado pela secretaria da escola manualmente no SGE.

De acordo com as definições do SENAI e VTEX, a opção de realizar matrícula pelo VTEX só fica disponível na área Para você (B2C), onde é o usuário final (aluno) que realiza a compra.

No momento da matrícula no SGE, caso a secretaria identifique que as vagas da turma estão esgotadas, ficará a cargo da secretaria decidir pelo aumento de vagas ou criação de nova turma. Não está previsto processo customizado para controle de vagas ao realizar a matrícula. 

A integração Kit de Cursos, permite a montagem de oferta que contempla mais de Curso.

Para maiores informações, acesse o Manual especifico para o Kit de curso, disponível neste Link.