Árvore de páginas


01. DADOS GERAIS

Produto:

TOTVS Varejo Franquias e Redes

Linha de Produto:

Franquias e Redes

Segmento:

Varejo

Módulo:

Retaguarda

Função:Motor de Promoções
País:Brasil
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :DVARLIVE-12615


02. SITUAÇÃO/REQUISITO

O produto Motor de Promoções está passando por uma grande reformulação e uma das alterações disponibilizadas foi uma nova API de integração.
É necessário realizar alterações no TVFR Retaguarda para que ele passe a integrar com a nova API.

03. SOLUÇÃO

Os parâmetros 9018 - Utiliza Motor de Promoções v.2.0? (1=SIM | 0-NAO) e 9070 - Url de login Motor de Promoções continuam sendo utilizadas  continuam sendo utilizados da mesma forma.

O time do Motor irá disponibilizar de forma gradual a integração com os clientes, por isso é necessário manter a compatibilidade com o ambiente atual.
Para isso foi criado o parâmetro 9324 - Utiliza nova Integração Motor de Promoções v.2.0? (1 = SIM | 0 = NAO). Caso ele esteja marcado passa a enviar as informações para a nova API, caso contrário continua enviando para a plataforma atual.

Para realizar as requisições para a nova API é necessário obter um token de acesso que será anexado ao cabeçalho de todas as mensagens, caso uma requisição seja feita sem o token ou com um token expirado a plataforma irá retornar um erro e não prosseguirá.
O token é obtido de forma automática pelo TVFR, porém ele precisa de duas informações para poder se autenticar no Motor e recuperar um token válido. Essas informações são o cliente_id e cliente_secret e ficam gravadas nos parâmetros 9325 - Login nova Integração Motor de Promoções v.2.0 - Client_ID e 9326 - Login nova Integração Motor de Promoções v.2.0 - Client_Secret respectivamente.

Quando utilizada a nova API, toda a comunicação realizada será registrada na tabela LogRequesdtAPI onde é possível ter um histório de todas as requisições efetuadas, sejam elas com sucesso ou erro.
Esse registro já é utilizado na comunicação com outras APIs para facilitar a análise de eventuais problemas.


Observações:
Como existe um ambiente por cliente no Motor e essa transição será feita de forma gradual, o time do Motor será responsável por liberar o acesso a esses ambiente fornecendo para isso o client_id e client_secret

Resumo:
Para funcionar a integração com a nova API do Motor de Promoções, os parâmetros devem estar configurados da seguinte forma:

    • 9018: Deve estar marcado indicando que o cliente faz uso do Motor
    • 9070: Deve conter a url responsável pela comunicação com a nova API ( disponibilizado pelo time do Motor )
    • 9324: Deve estar marcado indicando que o cliente está com o ambiente da nova API disponivel
    • 9325: Deve conter a informação do client_id que foi fornecido pelo time do Motor no momento da liberação do ambiente do cliente
    • 9326: Deve conter a informação do client_secret que foi fornecido pelo time do Motor no momento da liberação do ambiente do cliente



04. DEMAIS INFORMAÇÕES


05. ASSUNTOS RELACIONADOS