Obter um bloco

Devolve os detalhes completos de um bloco pelo id: tipo, propriedades, empresa dona, idioma, nome e conteúdo.

Este endpoint obtém os detalhes completos de um bloco específico pelo identificador único. Use-o para ler a estrutura de um bloco que você montou no painel de administração antes de criar um parecido pela API.

Quando a requisição dá certo, você recebe HTTP/1.1 200 OK e uma resposta JSON com os detalhes do bloco.

GET/api/blocks/{block_id}Admin

Obter um bloco específico pelo id

Parâmetros de caminho

block_idintegerobrigatório

O identificador único do bloco.

Exemplo de requisição

A requisição GET /api/blocks/38 devolve o bloco de id 38.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/blocks/38"

Resposta

200Bloco encontrado

json

{
  "block_id": "38",
  "type": "template",
  "properties": {
    "template": "blocks/static_templates/404.tpl"
  },
  "company_id": "1",
  "lang_code": "en",
  "name": "404",
  "content": ""
}

Campos da resposta

block_idstring

O identificador único do bloco.

typestring

O tipo do bloco (por exemplo, "template", "html", "menu").

propertiesobject

Propriedades adicionais, específicas do tipo de bloco.

company_idstring

O id da empresa dona do bloco.

lang_codestring

O código do idioma do conteúdo do bloco (por exemplo, "en" para inglês).

namestring

O nome do bloco.

contentstring

O conteúdo do bloco (pode vir vazio em certos tipos de bloco).

Veja também

Detalhes do bloco, a referência dos campos com um exemplo por tipo de bloco.
Atualizar um bloco, para alterar o que você acabou de ler.
Excluir um bloco, para removê-lo.

Obter um bloco

Devolve os detalhes completos de um bloco pelo id: tipo, propriedades, empresa dona, idioma, nome e conteúdo.

Quando a requisição dá certo, você recebe HTTP/1.1 200 OK e uma resposta JSON com os detalhes do bloco.

GET/api/blocks/{block_id}Admin

Obter um bloco específico pelo id

Parâmetros de caminho

block_idintegerobrigatório

O identificador único do bloco.

Exemplo de requisição

A requisição GET /api/blocks/38 devolve o bloco de id 38.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/blocks/38"

Resposta

200Bloco encontrado

json

{
  "block_id": "38",
  "type": "template",
  "properties": {
    "template": "blocks/static_templates/404.tpl"
  },
  "company_id": "1",
  "lang_code": "en",
  "name": "404",
  "content": ""
}

Campos da resposta

block_idstring

O identificador único do bloco.

typestring

O tipo do bloco (por exemplo, "template", "html", "menu").

propertiesobject

Propriedades adicionais, específicas do tipo de bloco.

company_idstring

O id da empresa dona do bloco.

lang_codestring

O código do idioma do conteúdo do bloco (por exemplo, "en" para inglês).

namestring

O nome do bloco.

contentstring

O conteúdo do bloco (pode vir vazio em certos tipos de bloco).

Veja também

Detalhes do bloco, a referência dos campos com um exemplo por tipo de bloco.
Atualizar um bloco, para alterar o que você acabou de ler.
Excluir um bloco, para removê-lo.