Histórico da Página

CONTEÚDO

1. Visão GeralExemplo de utilização
2. Fluxo do processo 
3. Contratação de uso de API
   
4. Solicitação de credenciais de acesso a API
5. Criação de um usuário no sistema
6. Geração de token
7. Configuração de parâmetros no sistema
8. Utilização da API

01. VISÃO GERAL

Esta documentação tem por objeto explicar o os passos que devem ser seguidos para que 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

A integração utiliza um endPoint da API V2 - "/api/totvsmoda/analytics/v2/branch-sale" , documentada na API - https://apitotvsmoda.bhan.com.br/api/totvsmoda/analytics/v2/swagger/index.html

02. FLUXO DO PROCESSO

03. CONTRATAÇÃO DE USO DE API

O primeiro passo, caso o cliente não tenha contrato a licença webservice, a ser tomado é o cliente realizar a contratação do serviço de uso de API junto a à TOTVS Moda. Para isso, 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 O canal de venda irá solicitar via e-mail direcionado a criacao@virtualagemail  criacao@virtualage.com.br as credenciais de acesso a à API esta . Essas credenciais permitiram permitirão que as API APIs sejam utilizadas.

O canal de venda irá retornar as credenciais client_id e client_secret para o cliente.

05. CRIAÇÃO DE UM USUÁRIO NO SISTEMA 

O cliente deve cadastrar um usuário no sistema para a integração.

O usuário deve ter o privilégio padrão e deve ser liberado na empresa que será realizada a integração.

Para sabe como criar um usuário acesse o link: https://centraldeatendimento.totvs.com/hc/pt-br/articles/360053175973-VA-ADM-Como-cadastrar-um-usu%C3%A1rio-Padr%C3%A3o

No futuro caso necessite integrar uma outra loja, deve apenas ser liberado a empresa no botão "LOGIN EMPRESA"

06. GERAÇÃO DE TOKEN

De posse das credencias deve ser gerado credenciais a Napp, deve  gerar um token que funcionará como uma espécie de chave que permitira executar as , permitindo a execução das requisições nos Endpoints.

, Para saber como gerar o token, o material a seguir poderá ser consultado: https://tdn.totvs.com/x/JY27Hw.

...

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

Caso seja necessário, o cliente deve verificar e configurar os parâmetros abaixo:

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 ". Neste parâmetro, deve ser informado informada a quantidade máxima de dias que podem ser consultados, levando em consideração a data atual por . Por exemplo: , suponhamos que hoje é dia 15 se . Se no parametro parâmetro for informado o valor 10, a consulta só poderá ser executada entre os dias 5 e 15 porem se tentar . Caso tente 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 é específico por empresa

   o

   , chamado "LST_OPER_API_BRANCH-SALE

   nele

   ". Nele, é possível informar quais

   as

   operações devem ser consideradas na consulta

   ,

   . Trata-se

   trata

   de uma lista

   então

   , portanto, várias operações podem ser informadas

   várias operações

   . Caso nenhuma operação seja informada, todas as operações

   serão  Consideradas

...

1. serão consideradas.

08. UTILIZAÇÃO DA API

Após seguir todos os passos anteriores já , é possível executar uma consulta e receber todos os dados de vendas conforme o filtro por empresa. segue Para visualizar a documentação Swagger da API "sale-branch que pode ser consultada para visualizar documentação swagger da mesma ", você pode consultar o seguinte link: https://tdnapitotvsmoda.totvsbhan.com/x/BzcELg.br/api/totvsmoda/analytics/v2/swagger/index.html

Esse é link de clientes que estão na nuvem TOTVS, clientes on-premise terão outra URL.