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

Listar idiomas

Devolve os idiomas instalados na sua loja com id, código, nome, status, país e direção de escrita.

Este endpoint obtém a lista de todos os idiomas instalados na sua loja. Use-o para montar um seletor de idioma em um tema personalizado, para conferir quais idiomas estão ativos, para criar integrações com serviços de tradução ou para construir ferramentas de conteúdo por idioma. Se você está montando uma loja multilíngue, chame-o primeiro e depois busque as variáveis de idioma de cada idioma.

GET/api/languagesAdmin

Listar todos os idiomas instalados

Parâmetros de consulta

pageintegerpadrão: 1
Página de resultados a devolver. Veja a Paginação.
items_per_pageintegerpadrão: 10
Quantidade de idiomas por página.

Exemplo de requisição

A referência escreve a requisição como GET /api/languages/.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/languages/"

Resposta

200Idiomas instalados
json
[
  {
    "lang_id": "1",
    "lang_code": "en",
    "name": "English",
    "status": "A",
    "country_code": "US",
    "direction": "ltr"
  },
  {
    "lang_id": "2",
    "lang_code": "es",
    "name": "Spanish",
    "status": "A",
    "country_code": "ES",
    "direction": "ltr"
  },
  {
    "lang_id": "3",
    "lang_code": "de",
    "name": "German",
    "status": "A",
    "country_code": "DE",
    "direction": "ltr"
  }
]

Campos da resposta

lang_idinteger
O identificador único do idioma.
lang_codestring
O código do idioma de duas letras (por exemplo, "en", "es", "fr").
namestring
O nome completo do idioma.
statusstring
AHD
O status do idioma: A ativo, H oculto, D desativado.
country_codestring
O código ISO do país associado ao idioma (usado para exibir a bandeira).
directionstring
ltrrtl
A direção de escrita do idioma: ltr da esquerda para a direita, rtl da direita para a esquerda.
Dica

Se você está desenvolvendo uma loja multilíngue, confira primeiro todos os idiomas instalados com este endpoint e depois busque as variáveis de idioma de cada um.

Veja também

  • Paginação, para percorrer a lista em páginas.
  • Obter um idioma, para ler um idioma pelo id.
  • Detalhes do idioma, para o significado de cada campo.
Anterior
Idiomas
Próxima
Paginação de idiomas
Nesta página
  • Exemplo de requisição
  • Resposta
  • Veja também