Histórico da Página

...

1. Visão Geral
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

...

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 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.

...

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

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

...

1. O primeiro é um parâmetro corporativo, o "NR_DIAS_API_BRANCH-SALE". Neste parâmetro, deve ser informada 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 parâmetro for informado o valor 10, a consulta só poderá ser executada entre os dias 5 e 15. Caso tente filtrar a partir do dia 04, será apresentada uma mensagem informando que a data excede o período permitido.

2. 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.

...

08. UTILIZAÇÃO DA API

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

...