API legada/Referência completa/Blocos e idiomas

GETIdiomas

Devolve a lista fixa de idiomas da API 1.0 (português e inglês) e permite ler um idioma pelo id ou pelo código.

Na Venddor 1.0, languages listava os idiomas cadastrados na loja, e cada recurso (produto, página, categoria) podia ter textos por lang_code. Na plataforma atual esta rota existe só para não quebrar clientes antigos: ela devolve uma lista fixa de dois idiomas, qualquer que seja a configuração da loja.

Para saber quais idiomas a loja realmente habilitou, consulte a configuração de idiomas no painel da loja. Mesmo que a loja tenha habilitado outros idiomas, como espanhol, esta rota continua devolvendo apenas pt e en.

Listar idiomas

GET/api/v1.0/languagesAutenticada

Listar os idiomas (lista fixa)

Parâmetros de consulta

lang_codestring

pten

Se informado, a resposta deixa de ser uma lista e vira um único objeto de idioma. Código desconhecido responde 404.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN. Qualquer usuário autenticado serve.

GET/api/languagesAutenticada

Alias de GET /api/v1.0/languages

Mesma resposta e mesmo comportamento de GET /api/v1.0/languages, inclusive o filtro lang_code. Os ids de idioma já são inteiros nas duas URLs.

Ler um idioma

GET/api/v1.0/languages/{id}Autenticada

Ler um idioma pelo id

Parâmetros de caminho

idintegerobrigatório

Id do idioma: 1 é português, 2 é inglês. O valor 0 é recusado com 400.

GET/api/languages/{id}Autenticada

Alias de GET /api/v1.0/languages/{id}

Mesma resposta e mesmo comportamento de GET /api/v1.0/languages/{id}.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/languages"
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/languages/2"

Resposta

200Lista de idiomas

json

{
  "languages": [
    { "lang_id": 1, "lang_code": "pt", "name": "Português (Brasil)", "status": "A", "country_code": "BR" },
    { "lang_id": 2, "lang_code": "en", "name": "English", "status": "A", "country_code": "US" }
  ],
  "params": { "total_items": 2 }
}

200Um idioma (por id, ou com ?lang_code=en)

json

{ "lang_id": 2, "lang_code": "en", "name": "English", "status": "A", "country_code": "US" }

Campos da resposta

lang_idinteger

Id fixo do idioma: 1 ou 2.

lang_codestring

pten

Código curto do idioma. Atenção: pt, e não pt-BR como no resto da plataforma.

namestring

Nome do idioma, no próprio idioma.

statusstring

Sempre A.

country_codestring

País associado (BR, US).

params.total_itemsinteger

Número de idiomas na lista (2). Só aparece na lista.

Erros

Status	Quando	Corpo
400	`id` não numérico	`{"message": "invalid lang_id", "status": 400}`
400	`id` igual a `0`	`{"error": "invalid id parameter"}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
404	Id sem idioma (qualquer outro número)	`{"message": "language not found", "status": 404}`
404	`lang_code` desconhecido	`{"message": "language not found: xx", "status": 404}`

Veja também

GETIdiomas

Devolve a lista fixa de idiomas da API 1.0 (português e inglês) e permite ler um idioma pelo id ou pelo código.

Listar idiomas

GET/api/v1.0/languagesAutenticada

Listar os idiomas (lista fixa)

Parâmetros de consulta

lang_codestring

pten

Se informado, a resposta deixa de ser uma lista e vira um único objeto de idioma. Código desconhecido responde 404.

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN. Qualquer usuário autenticado serve.

GET/api/languagesAutenticada

Alias de GET /api/v1.0/languages

Mesma resposta e mesmo comportamento de GET /api/v1.0/languages, inclusive o filtro lang_code. Os ids de idioma já são inteiros nas duas URLs.

Ler um idioma

GET/api/v1.0/languages/{id}Autenticada

Ler um idioma pelo id

Parâmetros de caminho

idintegerobrigatório

Id do idioma: 1 é português, 2 é inglês. O valor 0 é recusado com 400.

GET/api/languages/{id}Autenticada

Alias de GET /api/v1.0/languages/{id}

Mesma resposta e mesmo comportamento de GET /api/v1.0/languages/{id}.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/languages"
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/languages/2"

Resposta

200Lista de idiomas

json

{
  "languages": [
    { "lang_id": 1, "lang_code": "pt", "name": "Português (Brasil)", "status": "A", "country_code": "BR" },
    { "lang_id": 2, "lang_code": "en", "name": "English", "status": "A", "country_code": "US" }
  ],
  "params": { "total_items": 2 }
}

200Um idioma (por id, ou com ?lang_code=en)

json

{ "lang_id": 2, "lang_code": "en", "name": "English", "status": "A", "country_code": "US" }

Campos da resposta

lang_idinteger

Id fixo do idioma: 1 ou 2.

lang_codestring

pten

Código curto do idioma. Atenção: pt, e não pt-BR como no resto da plataforma.

namestring

Nome do idioma, no próprio idioma.

statusstring

Sempre A.

country_codestring

País associado (BR, US).

params.total_itemsinteger

Número de idiomas na lista (2). Só aparece na lista.

Erros

Status	Quando	Corpo
400	`id` não numérico	`{"message": "invalid lang_id", "status": 400}`
400	`id` igual a `0`	`{"error": "invalid id parameter"}`
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
404	Id sem idioma (qualquer outro número)	`{"message": "language not found", "status": 404}`
404	`lang_code` desconhecido	`{"message": "language not found: xx", "status": 404}`