Pular para o conteúdo principal

Pesquisa

Central de Ajuda SW

Como acessar e como funciona a API de Dados?

Nathalia Puccetti
  • Atualizado

A API de Dados da SW é utilizada para coletar dados do sistema SW para a análise e gestão da loja. Com ela você pode:

  • Exportar informações diretamente para softwares como Excel e Power BI, permitindo análise e visualização avançada dos dados.

  • Armazenar os dados coletados em um banco de dados, possibilitando o tratamento desses dados para a elaboração de relatórios e dashboards personalizados.

 

Como acessar e como funciona a API de Dados?

Existem duas versões da API de Dados, cada qual com informações e parâmetros específicos. Aqui, explicaremos como acessar e utilizar as duas versões. 

Primeira Versão
1. A primeira versão permite acessar dados sobre pagamentos e vendas realizadas no PDV, estoque de produtos, receitas e despesas financeiras, além das contas financeiras com seus respectivos saldos diários e fornecedores vinculados aos produtos.
 
2. Acesse a primeira versão em seu navegador clicando neste link.
 
3. Primeiro, preencha o campo api_key com o Token da API Reporting Data específico da loja e clique em Explore:
2.gif

Você pode conferir o Token da API Reporting Data com o atendimento responsável pela loja na SW. 

 

4. Após escolher a loja de onde virão os dados, selecione as informações que serão coletadas. Para isso, clique na informação desejada e, em seguida, na tabela correspondente:

3.gif

 

5. Em seguida, informe os parâmetros de data inicial e final da consulta e clique em Try it out!:

4.gif

O período não pode exceder 31 dias.

 

6. Com as informações abaixo você pode utilizar os dados coletados no software ou banco desejado:

6.png

    • Curl: Informações de comando utilizadas como parâmetros para enviar solicitações a uma API.
    • Request URL: Endereço completo da API que está sendo acessada. Inclui o protocolo (http/https), domínio, caminho do recurso e parâmetros de consulta.
    • Response Body: Corpo da resposta que a API retorna. Contém os dados ou informações solicitadas em formato JSON.
    • Response Code: Código de status que a API devolve, indicando se a requisição deu certo. Exemplo: O retorno 200 significa que foi consultado com sucesso, 400 indica que houve algum tipo problema e os detalhes estarão no campo Response Body.
    • Response Headers: Cabeçalhos adicionais na resposta da API. Fornecem informações extras como tipo de conteúdo, tamanho dos dados e etc.

 

 
Segunda Versão
1. A segunda versão permite coletar dados de movimentações de vendas, pagamentos, produtos vendidos, e descontos aplicados no PDV, como descontos de combos e convênios.
 
2. Acesse a segunda versão em seu navegador clicando neste neste link.
 
3. Primeiro, preencha o campo api_key com o Token da API Reporting Data específico da loja e clique em Explore:
3 - V2 Token.gif

Você pode conferir o Token da API Reporting Data com o atendimento responsável pela loja na SW. 

 
4. Após escolher a loja de onde virão os dados, selecione as informações que serão coletadas. Para isso, clique na informação desejada e, em seguida, na tabela correspondente:
4 - Selecionar tabela.gif
 
5. Em seguida, informe os parâmetros abaixo para a consulta e clique em Try it out!:
5 - V2 .gif
 
    • Sync: Informe o código Sincronizador de maior valor das consultas anteriores. Caso seja a primeira consulta, preencha com 0. Isso garante que o sistema retorne apenas os dados modificados após a última sincronização, reduzindo a quantidade de dados transferidos a cada consulta. Saiba mais no passo 5.1.

      Cada movimento, itens ou pagamento tem seu próprio número de sincronizador específico. 

    • Limite: Informe a quantidade limite de linhas que serão retornadas. O limite máximo é de 999 registros por vez. 

 

5.1. Para saber o código Sync desta consulta, no campo Response Body, localize o maior valor do parâmetro Sincronizador. Geralmente, esse valor corresponde ao código do último registro retornado:

5.1 - Sincronizador.gif

Neste exemplo, o parâmetro Sincronizador de valor mais alto foi 708518. Dessa forma, na próxima consulta, o valor utilizado como parâmetro Sync será 708518.

 

6. Com as informações abaixo você pode utilizar os dados coletados no software ou banco desejado:

6.png

    • Curl: Informações de comando utilizadas como parâmetros para enviar solicitações a uma API.
    • Request URL: Endereço completo da API que está sendo acessada. Inclui o protocolo (http/https), domínio, caminho do recurso e parâmetros de consulta.
    • Response Body: Corpo da resposta que a API retorna. Contém os dados ou informações solicitadas em formato JSON.
    • Response Code: Código de status que a API devolve, indicando se a requisição deu certo. Exemplo: O retorno 200 significa que foi consultado com sucesso, 400 indica que houve algum tipo problema e os detalhes estarão no campo Response Body.
    • Response Headers: Cabeçalhos adicionais na resposta da API. Fornecem informações extras como tipo de conteúdo, tamanho dos dados e etc.
 

 

 

Ajude-nos a evoluir deixando seu feedback nos comentários e compartilhando sugestões para novos artigos!

Relativo a

Comentários

0 comentário

Por favor, entre para comentar.