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

Paginação de idiomas

Os parâmetros page e items_per_page, que controlam quantos idiomas instalados a listagem devolve e qual página você recebe.

Ao obter os idiomas, você controla quantos resultados voltam e qual página de resultados é exibida com dois parâmetros de consulta. Eles valem para a chamada de listagem, GET /api/languages/, que responde com uma página contendo uma quantidade limitada de idiomas instalados.

Parâmetros de paginação

Parâmetros de consulta

pageintegerpadrão: 1
Define qual página de idiomas exibir. A resposta de GET /api/languages/ é uma página com uma quantidade limitada de idiomas instalados; este parâmetro indica o número da página a devolver.
items_per_pageintegerpadrão: 10
Controla quantos idiomas entram em cada página.
Dica

A paginação é útil até para idiomas, porque sistemas multilíngues grandes podem ter dezenas de opções de idioma.

Exemplo

GET/api/languagesAdmin

Devolver 2 idiomas da 2ª página da lista

Exemplo de requisição

Esta requisição devolve um array com informações de 2 idiomas da 2ª página da lista de idiomas instalados.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/languages/?page=2&items_per_page=2"

Resposta

A referência mostra a resposta da requisição simples de listagem, GET /api/languages/, com HTTP/1.1 200 OK e este JSON. Os idiomas vêm indexados pelo código, e os dados de paginação ficam no objeto params.

200Idiomas com dados de paginação
json
{
  "languages": {
    "en": {
      "lang_id": "1",
      "lang_code": "en",
      "name": "English",
      "status": "A",
      "country_code": "US",
      "direction": "ltr"
    },
    "ru": {
      "lang_id": "2",
      "lang_code": "ru",
      "name": "Русский",
      "status": "A",
      "country_code": "RU",
      "direction": "ltr"
    }
  },
  "params": {
    "items_per_page": "10",
    "page": 1,
    "total_items": 2
  }
}
Nota

A página Listar idiomas da referência mostra a mesma chamada respondida com um array simples de idiomas. Os dois formatos aparecem na referência, então confira a resposta da sua loja antes de depender de um deles.

Anterior
Listar idiomas
Próxima
Obter um idioma
Nesta página
  • Parâmetros de paginação
  • Exemplo
  • Exemplo de requisição
  • Resposta