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

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.

Pontos principais
  • Um idioma é identificado por lang_id (um inteiro na referência) e por lang_code (duas letras, por exemplo en).
  • O status é uma letra: A ativo, H oculto ou D desativado.
  • O country_code define o ícone da bandeira exibido ao lado do idioma no painel de administração e na loja.
  • Ao criar um idioma, você pode copiar todas as variáveis de idioma de outro com from_lang_code.
  • Não é possível excluir o idioma definido como idioma padrão do backend.

Como funciona

  1. Liste o que está instalado
    Chame Listar idiomas para ver os idiomas instalados e o status deles. Use a Paginação quando houver muitos.
  2. Adicione um idioma
    Crie um idioma com um lang_code único. Copie as variáveis de um idioma existente para não começar do zero.
  3. Traduza e publique
    Edite os textos pelas variáveis de idioma e comece com o status oculto ou desativado. Mude para A só quando o idioma estiver totalmente traduzido.
  4. Altere ou remova
    Atualize o idioma ou exclua-o.

Status do idioma

CódigoSignificado
AAtivo
HOculto
DDesativado

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

json
{
  "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étodoCaminhoFinalidadeAutenticação
GET/api/languagesListar os idiomas instalados, com paginaçãoAdministrador
GET/api/languages/{lang_id}Obter um idioma específicoAdministrador
POST/api/languagesCriar um idiomaAdministrador
PUT/api/languages/{lang_id}Atualizar um idiomaAdministrador
DELETE/api/languages/{lang_id}Excluir um idiomaAdministrador

Erros comuns

  • Criar um idioma com o lang_code de um que já vem com a Venddor. Esse idioma some da lista até você excluir o seu.
  • Mudar o lang_code em uma atualização. As variáveis do idioma desaparecem até você restaurar o código original.
  • Enviar o country_code em minúsculas. Escreva em maiúsculas, por exemplo US, 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.

Próximos passos

Listar idiomas
Veja os idiomas instalados e seus campos.
Criar um idioma
Adicione um idioma e copie as variáveis de outro.
Detalhes do idioma
A referência dos campos, com os valores de status e direção.
Variáveis de idioma
Gerencie os textos de cada idioma.
Anterior
Notificações
Próxima
Listar idiomas
Nesta página
  • Como funciona
  • Status do idioma
  • Conceitos principais
  • Código do idioma
  • Código do país e direção
  • O formato de um idioma
  • Endpoints
  • Erros comuns
  • Próximos passos