VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Configurações

Paginação de configurações

Controle quantas configurações a listagem devolve e qual página você recebe, com os parâmetros page e items_per_page.

As configurações do sistema podem ser numerosas, por isso a lista é devolvida em páginas. Você escolhe a página e o tamanho dela com dois parâmetros de consulta. As requisições usam o endereço base da loja ($BASE_URL/api) e credenciais HTTP Basic ($EMAIL:$API_KEY).

Parâmetros de paginação

Acrescente estes parâmetros às requisições para controlar a paginação das configurações do sistema:

GET/api/settingsAdmin

Lista as configurações, uma página por vez

Parâmetros de consulta

pageintegerpadrão: 1
Define qual página de configurações será exibida. As páginas são numeradas a partir de 1.
items_per_pageintegerpadrão: 10
Controla quantas configurações entram em cada página.
Dica

As configurações do sistema podem ser numerosas. A paginação organiza o resultado em blocos fáceis de manejar, principalmente quando você só se interessa por grupos específicos de configurações.

Exemplos

Só a página

GET /api/settings?page=5 devolve 10 configurações da 5ª página. Como items_per_page não foi informado, vale o padrão de 10.

Só o tamanho da página

GET /api/settings?items_per_page=20 devolve 20 configurações da primeira página. Como page não foi informado, vale o padrão 1.

Os dois parâmetros

GET /api/settings?page=5&items_per_page=20 devolve 20 configurações da 5ª página. Com os dois parâmetros informados, você controla totalmente o resultado.

Formato da resposta

A API devolve um array JSON com objetos de configuração do sistema, conforme os parâmetros de paginação. Cada objeto traz detalhes como o nome da configuração, o valor atual, o tipo de dado e as opções disponíveis (quando houver).

Importante

Algumas configurações do sistema podem ser somente leitura ou ter acesso restrito, conforme o seu nível de autenticação e as suas permissões na API.

Veja também

Configurações
Visão geral e as configurações comuns.
Endpoints
As URLs da API de configurações.
Anterior
Endpoints de configurações
Próxima
Campos de configurações
Nesta página
  • Parâmetros de paginação
  • Exemplos
  • Só a página
  • Só o tamanho da página
  • Os dois parâmetros
  • Formato da resposta
  • Veja também
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings?page=5"
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings?items_per_page=20"
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings?page=5&items_per_page=20"