API legada/Referência completa/Blocos e idiomas

GETBlocos: consulta

Lista os blocos de layout da vitrine de todos os layouts e lê um bloco pelo id.

Duas leituras dos blocos que montam as páginas da vitrine. A lista reúne os blocos de todos os layouts da loja e é paginada. A leitura individual busca um bloco pelo UUID. Em ambas, cada bloco informa o layout_id a que pertence, necessário depois para atualizar ou excluir.

Listar blocos

GET/api/v1.0/blocksAutenticada

Listar blocos de todos os layouts

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1. Valor inválido volta para 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora dessa faixa (ou inválido) volta para 10, sem erro.

Cabeçalhos

Authorizationstringobrigatório

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

GET/api/blocksAutenticada

Alias de GET /api/v1.0/blocks

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/blocks. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Ler um bloco

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

Ler um bloco pelo id

Procura o bloco em todos os layouts e devolve o primeiro que tiver o id. Se o id não é de nenhum bloco, a resposta é 404.

Parâmetros de caminho

iduuidobrigatório

Id do bloco (block_id da lista). O valor 0 é recusado com 400.

GET/api/blocks/{id}Autenticada

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

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/blocks/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/blocks?items_per_page=2"

Resposta

200Lista de blocos (reduzida a 1 item)

json

{
  "blocks": [
    {
      "block_id": "15055a16-fa48-4e96-a536-167209748c80",
      "name": "Store Logo",
      "type": "logo",
      "position": "header",
      "order": 0,
      "content": "{\"link_to_home\":true,\"max_height\":60}",
      "company_id": 0,
      "layout_id": 11,
      "status": "A"
    }
  ],
  "params": { "page": 1, "items_per_page": 2, "total_items": 37 }
}

200Um bloco

json

{
  "block_id": "15055a16-fa48-4e96-a536-167209748c80",
  "name": "Store Logo",
  "type": "logo",
  "position": "header",
  "order": 0,
  "content": "{\"link_to_home\":true,\"max_height\":60}",
  "company_id": 0,
  "layout_id": 11,
  "status": "A"
}

Campos da resposta

blocksarray

Blocos da página pedida. Página além do fim devolve lista vazia, com 200.

blocks[].block_iduuid

Id do bloco. Na URL sem v1.0, um inteiro derivado do UUID que não funciona de volta no caminho.

blocks[].namestring

Título do bloco.

blocks[].typestring

Tipo do bloco (logo, search_bar...).

blocks[].positionstring

Zona da página (header, main...).

blocks[].orderinteger

Posição dentro da zona, a partir de 0.

blocks[].contentstring

Configuração do bloco como texto JSON. Faça JSON.parse.

blocks[].company_idinteger

Sempre 0.

blocks[].layout_idinteger

Id do layout dono do bloco. Obrigatório para atualizar e excluir.

blocks[].statusstring

AD

A visível, D oculto.

paramsobject

page, items_per_page e total_items (total de blocos de todos os layouts, até 250 layouts lidos).

Erros

Status	Quando	Corpo
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	Nenhum bloco com esse id	`{"message": "Block not found", "status": 404}`
500	Falha ao ler os layouts	`{"message": "...", "status": 500}`

Veja também

GETBlocos: consulta

Lista os blocos de layout da vitrine de todos os layouts e lê um bloco pelo id.

Listar blocos

GET/api/v1.0/blocksAutenticada

Listar blocos de todos os layouts

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1. Valor inválido volta para 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora dessa faixa (ou inválido) volta para 10, sem erro.

Cabeçalhos

Authorizationstringobrigatório

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

GET/api/blocksAutenticada

Alias de GET /api/v1.0/blocks

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/blocks. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Ler um bloco

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

Ler um bloco pelo id

Procura o bloco em todos os layouts e devolve o primeiro que tiver o id. Se o id não é de nenhum bloco, a resposta é 404.

Parâmetros de caminho

iduuidobrigatório

Id do bloco (block_id da lista). O valor 0 é recusado com 400.

GET/api/blocks/{id}Autenticada

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

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/blocks/{id}. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/blocks?items_per_page=2"

Resposta

200Lista de blocos (reduzida a 1 item)

json

{
  "blocks": [
    {
      "block_id": "15055a16-fa48-4e96-a536-167209748c80",
      "name": "Store Logo",
      "type": "logo",
      "position": "header",
      "order": 0,
      "content": "{\"link_to_home\":true,\"max_height\":60}",
      "company_id": 0,
      "layout_id": 11,
      "status": "A"
    }
  ],
  "params": { "page": 1, "items_per_page": 2, "total_items": 37 }
}

200Um bloco

json

{
  "block_id": "15055a16-fa48-4e96-a536-167209748c80",
  "name": "Store Logo",
  "type": "logo",
  "position": "header",
  "order": 0,
  "content": "{\"link_to_home\":true,\"max_height\":60}",
  "company_id": 0,
  "layout_id": 11,
  "status": "A"
}

Campos da resposta

blocksarray

Blocos da página pedida. Página além do fim devolve lista vazia, com 200.

blocks[].block_iduuid

Id do bloco. Na URL sem v1.0, um inteiro derivado do UUID que não funciona de volta no caminho.

blocks[].namestring

Título do bloco.

blocks[].typestring

Tipo do bloco (logo, search_bar...).

blocks[].positionstring

Zona da página (header, main...).

blocks[].orderinteger

Posição dentro da zona, a partir de 0.

blocks[].contentstring

Configuração do bloco como texto JSON. Faça JSON.parse.

blocks[].company_idinteger

Sempre 0.

blocks[].layout_idinteger

Id do layout dono do bloco. Obrigatório para atualizar e excluir.

blocks[].statusstring

AD

A visível, D oculto.

paramsobject

page, items_per_page e total_items (total de blocos de todos os layouts, até 250 layouts lidos).

Erros

Status	Quando	Corpo
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	Nenhum bloco com esse id	`{"message": "Block not found", "status": 404}`
500	Falha ao ler os layouts	`{"message": "...", "status": 500}`