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

Listar langvars

Devolve as variáveis de idioma do idioma padrão, ou de um idioma específico escolhido pelo id ou pelo código de duas letras.

Este endpoint obtém as variáveis de idioma (langvars) da sua loja. Você pode buscar as variáveis do idioma padrão, ou as de um idioma específico, indicado pelo id no caminho ou pelo código de duas letras na query string. Use-o para exportar variáveis para a localização, para montar o seu próprio sistema de gestão de traduções, para comparar variáveis entre idiomas ou para achar traduções que faltam na loja.

Dica

Use a paginação para limitar o número de variáveis devolvidas em uma única requisição: uma loja típica tem centenas ou milhares delas.

Para o idioma padrão

GET/api/langvarsAdmin

Listar as variáveis de idioma do idioma padrão

Parâmetros de consulta

pageintegerpadrão: 1
Página de resultados a devolver.
items_per_pageintegerpadrão: 10
Quantidade de variáveis por página.

Esta requisição devolve as variáveis de idioma do idioma padrão definido nas configurações da loja (Configurações, Aparência, idioma padrão do backend).

Exemplo de requisição

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

Resposta

200Variáveis de idioma
json
[
  {
    "lang_code": "en",
    "name": "checkout_terms_n_conditions",
    "value": "I accept the Terms and Conditions"
  },
  {
    "lang_code": "en",
    "name": "free_shipping",
    "value": "Free shipping"
  },
  {
    "lang_code": "en",
    "name": "signin",
    "value": "Sign in"
  }
]

Para um idioma específico pelo id

GET/api/languages/{lang_id}/langvarsAdmin

Listar as variáveis de idioma de um idioma específico

Parâmetros de caminho

lang_idintegerobrigatório
O identificador único do idioma.

Use este endpoint para obter as variáveis de idioma de um idioma específico, identificado pelo id. Para o idioma de id 1, a requisição é GET /api/languages/1/langvars/.

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

Para um idioma específico pelo código

Você também pode indicar o idioma pelo código de duas letras com o parâmetro de consulta sl, em GET /api/langvars/.

Parâmetros de consulta

slstringobrigatório
O código de duas letras do idioma (por exemplo, "en", "es", "fr").

Por exemplo, GET /api/langvars/?sl=es devolve todas as variáveis de idioma do espanhol.

bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/langvars/?sl=es"

Veja também

  • Paginação, para page, items_per_page e a resposta com params.
  • Obter uma langvar, para ler uma variável pelo nome.
  • Detalhes da langvar, para os três campos.
Anterior
Variáveis de idioma
Próxima
Paginação de langvars
Nesta página
  • Para o idioma padrão
  • Exemplo de requisição
  • Resposta
  • Para um idioma específico pelo id
  • Para um idioma específico pelo código
  • Veja também