Esta documentação tem por objeto explicar 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.
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
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 à TOTVS Moda. Para isso, é necessário realizar contato com o setor comercial ou com seu canal de vendas.
O canal de venda irá solicitar via e-mail [email protected] as credenciais de acesso à API. Essas credenciais permitirão que as APIs sejam utilizadas.
O canal de venda irá retornar as credenciais client_id e client_secret para o cliente.
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"
De posse das credenciais a Napp, deve gerar um token que funcionará como uma espécie de chave, 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.
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:
O segundo parâmetro é específico por empresa, chamado "LST_OPER_API_BRANCH-SALE". Nele, é possível informar quais operações devem ser consideradas na consulta. Trata-se de uma lista, portanto, várias operações podem ser informadas. Caso nenhuma operação seja informada, todas as operações serão consideradas.
Após seguir todos os passos anteriores, é possível executar uma consulta e receber todos os dados de vendas conforme o filtro por empresa. Para visualizar a documentação Swagger da API "sale-branch", você pode consultar o seguinte link: https://apitotvsmoda.bhan.com.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.