CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Contratação de uso de API
   
4. Solicitação de credenciais de acesso a API
5. Geração de token
6. Configuração de parâmetros no sistema
7. Utilização da API

01. VISÃO GERAL

Esta documentação tem por objeto explicar o os passos que devem ser seguidos para possa ser executada uma integração com a Napp Solutions desde a contratação dos serviços necessários dentro do TOTVS Moda até a consulta que a Napp realizará para obter os dados.

02. EXEMPLO DE UTILIZAÇÃO

Esta integração é utilizada por clientes que necessitam de integrações com a Napp Solutions em seus relacionamentos com Shopping Centers

03. CONTRATAÇÃO DE USO DE API

O primeiro passo a ser tomado é a contratação do serviço de uso de API junto a TOTVS Moda, para isso é necessário realizar contato com o setor comercial ou com seu canal de vendas

04. SOLICITAÇÃO DE CREDENCIAIS DE ACESSO A API

Deve ser solicitado via e-mail direcionado a criacao@virtualage.com.br as credenciais de acesso a API esta credenciais permitiram que as API sejam utilizadas

05. GERAÇÃO DE TOKEN

De posse das credencias deve ser gerado um token que funcionará como uma espécie de chave que permitira executar as requisições nos Endpoints, Para saber como gerar o token o material a seguir poderá ser consultado: https://tdn.totvs.com/x/JY27Hw

06. CONFIGURAÇÃO DE PARÂMETROS NOS SISTEMA

Para a utilização da API "/api/totvsmoda/analytics/v2/branch-sale" é recomendado a marcação de dois parâmetros:

1. O primeiro é um parâmetro corporativo o NR_DIAS_API_BRANCH-SALE neste parâmetro deve ser informado a quantidade máxima de dias que podem ser consultados levando em consideração a data atual por exemplo: suponhamos que hoje é dia 15 se no parametro for informado o valor 10 a consulta só poderá ser executada entre os dias 5 e 15 porem se tentar filtrar a partir do dia 04 será apresentada uma mensagem informando que a data excede o período permitido.
2. O segundo se trata de um parâmetro por empresa o LST_OPER_API_BRANCH-SALE nele é possível informar quais as operações devem ser consideradas na consulta, se trata de uma lista então podem ser informadas várias operações. Caso nenhuma operação seja informada todas as operações serão  Consideradas

07. UTILIZAÇÃO DA API

Após todos os passos anteriores já é possível executar uma consulta e receber todos os dados de vendas conforme filtro por empresa.

segue documentação da API sale-branch que pode ser consultada para visualizar documentação swagger da mesma : https://tdn.totvs.com/x/BzcELg