Idiomas
A API de Languages gerencia os idiomas instalados na sua loja, que definem os textos da loja virtual e do painel de administração.
A Venddor oferece suporte a vários idiomas na interface e no conteúdo da sua loja. Um idioma é um locale instalado, com um código de duas letras, um nome, um status, um país (usado para a bandeira) e uma direção de escrita. A API de Languages permite listar os idiomas instalados, ler um deles, adicionar um novo, alterar seus dados e excluí-lo.
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/languages. Os textos em si ficam nas variáveis de idioma, que têm uma seção própria: Variáveis de idioma.
Como funciona
- Liste o que está instaladoChame Listar idiomas para ver os idiomas instalados e o status deles. Use a Paginação quando houver muitos.
- Adicione um idiomaCrie um idioma com um
lang_codeúnico. Copie as variáveis de um idioma existente para não começar do zero. - Traduza e publiqueEdite os textos pelas variáveis de idioma e comece com o status oculto ou desativado. Mude para
Asó quando o idioma estiver totalmente traduzido. - Altere ou remova
Status do idioma
| Código | Significado |
|---|---|
A | Ativo |
H | Oculto |
D | Desativado |
Conceitos principais
Código do idioma
lang_code é o código do idioma de duas letras, como en, es ou fr. Ele precisa ser único entre os idiomas instalados. Ao criar um idioma, não reutilize o código de um idioma que já vem com a Venddor: esse idioma some da lista até você excluir o que criou. Também não mude o lang_code de um idioma existente: todas as variáveis de idioma dele desaparecem até você devolver o código original.
Código do país e direção
country_code é o código ISO do país a que o idioma pertence, escrito em letras maiúsculas (por exemplo US). Ele determina o ícone da bandeira. direction é ltr (da esquerda para a direita) ou rtl (da direita para a esquerda).
O formato de um idioma
{
"lang_id": "2",
"lang_code": "es",
"name": "Spanish",
"status": "A",
"country_code": "ES",
"direction": "ltr"
}A página Detalhes do idioma descreve cada campo.
Endpoints
| Método | Caminho | Finalidade | Autenticação |
|---|---|---|---|
| GET | /api/languages | Listar os idiomas instalados, com paginação | Administrador |
| GET | /api/languages/{lang_id} | Obter um idioma específico | Administrador |
| POST | /api/languages | Criar um idioma | Administrador |
| PUT | /api/languages/{lang_id} | Atualizar um idioma | Administrador |
| DELETE | /api/languages/{lang_id} | Excluir um idioma | Administrador |
Erros comuns
- Criar um idioma com o
lang_codede um que já vem com a Venddor. Esse idioma some da lista até você excluir o seu. - Mudar o
lang_codeem uma atualização. As variáveis do idioma desaparecem até você restaurar o código original. - Enviar o
country_codeem minúsculas. Escreva em maiúsculas, por exemploUS,GB,DE. - Ativar um idioma novo antes de traduzi-lo. Comece com o status oculto ou desativado.
- Tentar excluir o idioma padrão. A referência diz que não dá para excluir o idioma definido como padrão do backend em Configurações, Aparência.