Convenções das Requests - Paginação

Veja como funcionam as requests da API do My Turn.

Convenções das Requests - Paginação

A API do My Turn utiliza paginação baseada em query string para todas as requests de listagem. Isso garante que os resultados sejam retornados de forma eficiente, mesmo em coleções com milhares de registros.

Parâmetros de Paginação

Todas as rotas de listagem aceitam os seguintes parâmetros:

Parâmetro	Tipo	Descrição	Exemplo
`page`	Integer	Número da página desejada (valor padrão: `1`).	`page=2`
`page_size`	Integer	Quantidade de registros por página (máximo: `20`, padrão: `10`).	`page_size=20`

Estrutura da Response

As responses de listagem sempre incluem as chaves links e meta, que fornecem informações de paginação.

{
  "data": [
    {
      "id": 1,
      "type": "sellers",
      "attributes": {
        "name": "Ana Paula"
      }
    }
  ],
  "links": {
    "self": "https://myturn.com.br/api/public/v1/sellers?page=1&page_size=10",
    "next": "https://myturn.com.br/api/public/v1/sellers?page=2&page_size=10",
    "prev": null,
    "first": "https://myturn.com.br/api/public/v1/sellers?page=1&page_size=10",
    "last": "https://myturn.com.br/api/public/v1/sellers?page=5&page_size=10",
  },
  "meta": {
    "page": 1,
    "page-size": 10,
    "total-pages": 5,
    "total-items": 50
  }
}

Request

Filtros