Listas em páginas na nossa API: page, per_page e ler todas as páginas sem gastar pedidos

WhatsApp e APIs·· 21 visualizações· 3 min de leitura

A resposta curta: as operações de lista devolvem os resultados em páginas. Escolhe a página com page (a primeira é a 1) e quantos resultados quer com per_page, de 1 a 100; sem ele, vêm 10. O meta da resposta diz o total e quantas páginas há.

Os parâmetros

Parâmetro O que é
page O número da página. A primeira é a 1.
per_page Quantos resultados por página, de 1 a 100. Por omissão, 10.

curl "https://api.interweb.co.mz/v1/domains?page=2&per_page=50" -H "Authorization: Bearer $RLX_API_KEY"

O que vem na resposta

{
"data": [ ... ],
"meta": { "page": 2, "per_page": 50, "total": 120, "total_pages": 3 }
}

Campo de meta O que é
page A página devolvida.
per_page Resultados por página.
total Resultados no total.
total_pages Páginas no total.

Ler todas as páginas

1 Comece em page=1, de preferência com per_page=100.
2 Junte os resultados de data ao que já tem.
3 Continue enquanto page for menor do que total_pages, pedindo a página seguinte.
4 Respeite os limites: cada página conta como um pedido. Se receber 429, espere o Retry-After e continue de onde parou.
Uma lista grande com per_page pequeno gasta pedidos à toa. 120 domínios com 10 por página são 12 pedidos; com 100 por página, são 2. Com 90 pedidos por minuto por chave, a diferença nota-se. Veja os limites de pedidos.

Que listas vêm em páginas, e com que filtros

Lista Ordem Filtro
GET /v1/domains Primeiro os próximos a expirar status, por exemplo ?status=active
GET /v1/services Primeiro os mais recentes status, por exemplo ?status=active
GET /v1/invoices Primeiro as mais recentes status, por exemplo ?status=unpaid
GET /v1/tickets Primeiro os que têm a resposta mais recente status, por exemplo ?status=open
GET /v1/servers
GET /v1/catalog/products group_id
GET /v1/extras kind, por exemplo ?kind=ssl
GET /v1/account/contacts, GET /v1/account/users Nos utilizadores, primeiro o dono
GET /v1/reseller/services
Filtre antes de paginar. Se só quer as facturas por pagar, ?status=unpaid&per_page=100 traz o que interessa em muito menos páginas do que ler todas as facturas e filtrar depois. Para saber se algo mudou sem ler tudo de novo, veja também webhook ou consulta periódica.

Quer experimentar a paginação sem escrever código? A documentação, a partir da página da API, tem o Playground em cada operação de lista.

Ver a página da API

VEJA TAMBÉM

Limites de pedidos da API: por chave, por conta e por tarefa, os cabeçalhos e o que fazer num 429

Os códigos de erro da nossa API: o que quer dizer cada um, e quais vale a pena repetir

Domínios pela API: consultar um nome, registar, renovar e transferir com o saldo

Facturas pela API: listar, PDF, pagar com saldo, ciclo de renovação e cancelamentos

A nossa API numa página: o que pode automatizar na sua conta, área a área

Webhook ou consulta periódica: como um sistema fica a saber que algo mudou noutro

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 321,75 MT/mês (plano de 3 anos, com cupão)

Ver planos
Esta resposta foi útil? A sua resposta ajuda-nos a melhorar este artigo.