API legada/Referência completa/Variáveis de idioma

Criar uma langvar

Cria uma variável de idioma para o idioma padrão ou para um idioma específico; devolve o nome da nova variável.

As variáveis de idioma (langvars) guardam o conteúdo de texto que aparece na loja e no painel de administração em idiomas diferentes. Esta página cobre dois endpoints: um cria uma variável para o idioma padrão, o outro para um idioma específico. Quando a variável é criada, você recebe 201 Created e o nome dela; quando não é possível criá-la, por parâmetros inválidos ou outros problemas, você recebe 400 Bad Request.

Idioma padrão

POST/api/langvarsAdmin

Criar uma variável de idioma para o idioma padrão

Parâmetros de consulta

slstring

Código de duas letras do idioma em que criar a variável (por exemplo, "en"). Sem ele, usa-se o idioma padrão.

Corpo da requisição

namestringobrigatório

O nome interno da variável de idioma na Venddor. É o identificador que você usa para obter a variável pela API.

valuestring

O texto que as pessoas vão ver na loja ou no painel de administração.

O idioma padrão é o idioma padrão do backend, configurado em Configurações, Aparência. A referência escreve o endpoint como POST /api/langvars/.

Idioma específico

POST/api/languages/{lang_id}/langvarsAdmin

Criar uma variável de idioma para um idioma específico

Parâmetros de caminho

lang_idintegerobrigatório

O id do idioma para o qual criar a variável.

Corpo da requisição

namestringobrigatório

O nome interno da variável de idioma na Venddor.

valuestring

O texto que as pessoas vão ver na loja ou no painel de administração.

Você também pode indicar o idioma com um parâmetro de consulta: POST /api/langvars/?sl=en.

Exemplo de requisição

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

bash

curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X POST "$BASE_URL/api/langvars/" -d '{
  "name": "test_variable",
  "value": "This is the text that will appear instead of the language variable for the specified language."
}'

Resposta

201Variável de idioma criada

json

{
  "name": "test_variable"
}

Erros

Status	Quando
`201 Created`	A variável de idioma foi criada e o nome dela é devolvido
`400 Bad Request`	Não foi possível criar a variável de idioma, por parâmetros inválidos ou outros problemas

Notas de implementação

Use nomes de variável descritivos, que indiquem com clareza o conteúdo que representam.
Siga uma convenção de nomes consistente, para organizar melhor.
Crie variáveis de idioma para todos os idiomas aceitos pela loja, para garantir uma experiência multilíngue completa.
Teste as variáveis de idioma vendo a loja em idiomas diferentes.

Veja também

Detalhes da langvar, para os campos.
Atualizar uma langvar, para mudar o valor depois.

Criar uma langvar

Cria uma variável de idioma para o idioma padrão ou para um idioma específico; devolve o nome da nova variável.

Idioma padrão

POST/api/langvarsAdmin

Criar uma variável de idioma para o idioma padrão

Parâmetros de consulta

slstring

Código de duas letras do idioma em que criar a variável (por exemplo, "en"). Sem ele, usa-se o idioma padrão.

Corpo da requisição

namestringobrigatório

O nome interno da variável de idioma na Venddor. É o identificador que você usa para obter a variável pela API.

valuestring

O texto que as pessoas vão ver na loja ou no painel de administração.

O idioma padrão é o idioma padrão do backend, configurado em Configurações, Aparência. A referência escreve o endpoint como POST /api/langvars/.

Idioma específico

POST/api/languages/{lang_id}/langvarsAdmin

Criar uma variável de idioma para um idioma específico

Parâmetros de caminho

lang_idintegerobrigatório

O id do idioma para o qual criar a variável.

Corpo da requisição

namestringobrigatório

O nome interno da variável de idioma na Venddor.

valuestring

O texto que as pessoas vão ver na loja ou no painel de administração.

Você também pode indicar o idioma com um parâmetro de consulta: POST /api/langvars/?sl=en.

Exemplo de requisição

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

bash

curl -u "$EMAIL:$API_KEY" -H "Content-Type: application/json" -X POST "$BASE_URL/api/langvars/" -d '{
  "name": "test_variable",
  "value": "This is the text that will appear instead of the language variable for the specified language."
}'

Resposta

201Variável de idioma criada

json

{
  "name": "test_variable"
}

Erros

Status	Quando
`201 Created`	A variável de idioma foi criada e o nome dela é devolvido
`400 Bad Request`	Não foi possível criar a variável de idioma, por parâmetros inválidos ou outros problemas

Notas de implementação

Use nomes de variável descritivos, que indiquem com clareza o conteúdo que representam.
Siga uma convenção de nomes consistente, para organizar melhor.
Crie variáveis de idioma para todos os idiomas aceitos pela loja, para garantir uma experiência multilíngue completa.
Teste as variáveis de idioma vendo a loja em idiomas diferentes.

Veja também

Detalhes da langvar, para os campos.
Atualizar uma langvar, para mudar o valor depois.