Documentação Geral

API – Como utilizar a paginação no EndPoint Listagem de Produtos cadastrados na Systax


    Como utilizar a paginação no EndPoint Listagem de Produtos cadastrados na Systax

    Por Rafael Sena

     

    O EndPoint “Listagem de Produtos” é utilizado via método GET e tem por padrão um limite de 100 registros por paginação, busca os produtos existentes no Portal CFM e exibi a listagem via API. Para cada produto cadastrado é entregue um ID gerado pela Systax, que pode ser utilizado como uma das funcionalidades dessa API, pois o cliente ou parceiro podem utilizar o ID como um parâmetro para uma busca específica de um produto nesta mesma API, bem para realizar a exclusão via integração.

    A API também exibe na primeira página o total de itens existentes no Portal CFM, o cliente ou parceiro pode realizar um confronto da quantidade de produtos contidos na sua base Systax versus o que consta no ERP, essa funcionalidade garante um dado preciso, pois não é preciso consumir todas as páginas para descobrir a quantidade de produtos existentes.

    Como utilizar a paginação no EndPoint Listagem de Produtos?

    1. Gerar Token de validação para acesso ao EndPoint.

     

    1. Realizar primeira consulta de produtos no EndPoint: https://app.systax.com.br/cfm/products. Inserir Token na autorização, type Bearer Token, informar método GET e rodar primeira chamada.
       

     

    No final da primeira página, você irá encontrar o bloco de informações chamado “paginação”, nele contém as seguintes informações:

    - Total de registros
    - Número de páginas
    - Número por página
    - Página atual
    - Itens por página



     

    1. Para paginar a listagem de produtos, utilizando o mesmo EndPoint, acrescente interrogação “?pagina_atual=” no EndPoint, informando também o número da página seguinte a ser retornada, conforme exemplo abaixo.

      Informação complementar: É possível navegar por qualquer página da base de produtos.

      Ex: https://app.systax.com.br/cfm/products?pagina_atual=2



      A importância deste tópico é demonstrar, de forma prática, como utilizar a paginação no EndPoint Listagem de Produtos da API utilizada para consulta de produtos cadastrados na Systax.

    Voltar


Versão do documento: 44 Publicação: 9/22/2023