alerts.beta
Background - API1Created with Sketch.

Paginação

Na plataforma da Hotmart, nós podemos encontrar algumas coleções de recursos. Coleções de usuários, de assinaturas, produtos, entre muitos outros. Essas coleções também podem ser chamadas de listas.

A API da Hotmart possui endpoints que dão acesso a algumas dessas listas de elementos que em alguns casos podem se tornar muito grandes.

Imagina um endpoint que retorna todas as vendas do ano anterior, por exemplo. Muita coisa, não é mesmo?

Pensando em melhorar a experiência, usamos uma estrutura de paginação, utilizando a abordagem de cursor pagination.

Parâmetros da requisição

  • max_resultsinteger

    O número máximo de itens por página que podem ser retornados.

  • page_tokenstring

    O cursor usado na paginação. Ele é uma referência para a parte que você quer ir na lista.

    Por exemplo, você faz uma requisição que te retorna 50 itens, mas o total de itens é 95. Adicionando o query param page_token com o valor do atributo next_page_token, você irá acessar os 45 restantes. Numa próxima requisição, trocando o page_token pelo valor do prev_page_token, você irá acessar novamente os 50 itens anteriores.

Retorno

  • itemsarray containing objects

    Coleção de itens do tipo da lista, como lista de vendas por exemplo.

  • page_infoobject

    Informações de paginação, com os possíveis dados abaixo:

    general.showParameters
Response
{
  "items": [...],
  "page_info": {
      "total_results": 30,
      "next_page_token": "eyJwYWdlIjoyLCJyb3dzIjoxMH0=",
      "prev_page_token": "eyJwYWdlIjoyLCJyb3dzIjoxMH0=",
      "results_per_page": 10
  }
}

Onde o atributo items contém uma coleção de itens do tipo da lista, como lista de vendas por exemplo.

isPageUseful.question