Histórico da Página
CONTEÚDO
- Visão GeralExemplo de utilização
- Fluxo do processo
- Contratação de uso de API
- Solicitação de credenciais de acesso a API
- Geração de token
- Configuração de parâmetros no sistema
- Utilização da API
...
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 à 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 O canal de venda irá solicitar via e-mail direcionado a 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.
05. GERAÇÃO DE TOKEN
De posse das credenciais , deve ser gerado 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.
06. 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:
...
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://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.