Variáveis de idioma
As variáveis de idioma (langvars) guardam os textos da loja em cada idioma; a API de Langvars lê e grava essas variáveis.
A maior parte dos textos da Venddor fica guardada em variáveis de idioma, ou langvars, para abreviar. Uma langvar é um par chave-valor: a chave é o nome da variável (por exemplo product_added_to_cart) e o valor é o texto exibido em um idioma específico (por exemplo "Product has been added to your cart"). É assim que o mesmo elemento da loja pode mostrar textos diferentes em idiomas diferentes.
Toda chamada usa as credenciais HTTP Basic de um administrador ($EMAIL:$API_KEY) e o endereço da sua loja ($BASE_URL), então os endpoints abaixo aparecem como $BASE_URL/api/langvars. Os idiomas em si são gerenciados em Idiomas.
Como funciona
- Escolha o idiomaUse o idioma padrão, ou indique o idioma pelo id ou pelo código com
sl. - Leia as variáveisListe as langvars página por página, ou obtenha uma pelo nome.
- Grave a traduçãoCrie uma variável, ou atualize o valor dela em cada idioma.
A referência sugere estes usos comuns: exportar variáveis para serviços de tradução, atualizar várias variáveis de uma vez, criar variáveis para módulos personalizados e sincronizar variáveis entre desenvolvimento e produção.
Conceitos principais
O nome de uma variável
O name é o identificador usado para obter a variável. Use números, sublinhados e letras minúsculas do alfabeto latino básico ISO, o que mantém os nomes compatíveis e mais fáceis de gerenciar.
Escolhendo o idioma
| Forma | Exemplo |
|---|---|
| Idioma padrão | GET /api/langvars/ |
| Idioma pelo id | GET /api/languages/1/langvars/ |
| Idioma pelo código | GET /api/langvars/?sl=es |
O formato de uma langvar
A página Detalhes da langvar descreve cada campo.
Endpoints
| Método | Caminho | Finalidade | Autenticação |
|---|---|---|---|
| GET | /api/langvars | Listar as variáveis do idioma padrão | Administrador |
| GET | /api/languages/{lang_id}/langvars | Listar as variáveis de um idioma | Administrador |
| GET | /api/langvars/{name} | Obter uma variável no idioma padrão | Administrador |
| GET | /api/languages/{lang_id}/langvars/{name} | Obter uma variável em um idioma | Administrador |
| POST | /api/langvars | Criar uma variável no idioma padrão | Administrador |
| POST | /api/languages/{lang_id}/langvars | Criar uma variável em um idioma | Administrador |
| PUT | /api/languages/{lang_id}/langvars/{name} | Atualizar uma variável | Administrador |
| PUT | /api/langvars/{name} | Atualizar uma variável | Administrador |
| DELETE | /api/langvars/{name} | Excluir uma variável | Administrador |
A Paginação descreve page e items_per_page para as listas.
Erros comuns
- Ler a lista inteira de uma vez. Uma loja pode ter milhares de variáveis (o exemplo de paginação mostra 4673), então percorra em páginas.
- Esquecer o idioma. Sem
lang_idnemsl, você trabalha só no idioma padrão. - Excluir uma variável para corrigir um idioma. A exclusão a remove de todos os idiomas; atualize o valor.
- Usar espaços ou maiúsculas no
name. Fique com letras minúsculas, números e sublinhados. - Esperar que uma atualização falhe com um nome desconhecido. Ela cria a variável.