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

Criar um idioma

Adiciona um novo idioma à loja, com a opção de copiar as variáveis de idioma de outro; devolve o novo lang_id.

Este endpoint cria um novo idioma na sua loja. Os idiomas são o que permite oferecer uma experiência multilíngue aos clientes. A referência escreve o endpoint como POST /api/languages/. Quando o idioma é criado, você recebe 201 Created e o id dele; quando não é possível criá-lo, por parâmetros inválidos ou outros problemas, você recebe 400 Bad Request.

POST/api/languagesAdmin

Criar um idioma

Corpo da requisição

lang_codestringobrigatório
Código do idioma de duas letras. Precisa ser único entre todos os idiomas instalados.
namestringobrigatório
O nome de exibição do idioma.
statusstring
AHD
Status do idioma: A (ativo), H (oculto) ou D (desativado).
country_codestring
Código ISO do país (em letras maiúsculas). Determina o ícone da bandeira exibido no painel de administração e na loja.
from_lang_codestring
O código do idioma de onde copiar as variáveis de idioma. Se não for informado, as variáveis vêm de CART_LANGUAGE.

Envie os parâmetros no corpo da requisição HTTP, no formato do Content-Type que você informar.

Atenção

Não use o lang_code de nenhum idioma que já vem com a Venddor, ou esse idioma some da lista até você excluir o idioma que criou.

Dica

Escreva o country_code em letras maiúsculas (por exemplo, "US" para Estados Unidos). Você encontra uma lista de códigos ISO de países em countrycode.org.

Nota

Enviar um POST para /api/languages/?sl=en tem o mesmo efeito de informar "from_lang_code": "en" no corpo JSON.

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X POST "$BASE_URL/api/languages/" -d '{
  "lang_code": "ts",
  "name": "Test",
  "status": "A",
  "country_code": "US",
  "from_lang_code": "en"
}'

Resposta

201Idioma criado
json
{
  "lang_id": 3
}

Erros

StatusQuando
201 CreatedO idioma foi criado e o id dele é devolvido
400 Bad RequestNão foi possível criar o idioma, por parâmetros inválidos ou outros problemas

Notas de implementação

  • Escolha um código de idioma de duas letras único e adequado, que siga os padrões internacionais.
  • Confira se o código do país está correto, para que a bandeira apareça direito.
  • Considere usar from_lang_code para copiar traduções existentes e ganhar tempo na configuração.
  • Use o status "Ativo" só quando o idioma estiver totalmente traduzido e pronto para os clientes.

Veja também

  • Detalhes do idioma, para os campos e os valores de status.
  • Atualizar um idioma, para alterá-lo depois.
Anterior
Detalhes do idioma
Próxima
Atualizar um idioma
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Notas de implementação
  • Veja também