Exemplos de Pages

Uma requisição e uma resposta para cada operação de Pages: listar, obter, criar, atualizar e excluir uma página de conteúdo.

Esta página mostra uma chamada para cada operação da API de Pages, com a requisição, os códigos de status e a resposta. As chamadas usam $BASE_URL/api/2.0 e as credenciais HTTP Basic $EMAIL:$API_KEY. Repare que os exemplos de criação e atualização enviam um corpo em texto puro, com pares nome=valor unidos por & e o cabeçalho Content-type: text/plain, e não JSON.

Listar páginas

GET/api/2.0/pagesAdmin

Obter a lista de páginas com suas propriedades

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/pages"

Obter uma página

GET/api/2.0/pages/{id}Admin

Obter os detalhes de uma página específica pelo id

Parâmetros de caminho

idintegerobrigatório

O identificador único da página.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/pages/1"

Criar uma página

POST/api/2.0/pagesAdmin

Criar uma nova página

Campos obrigatórios: page_type, page.

Campos disponíveis: page_type, page, parent_id, status, position, usergroup_ids, localization, new window (somente para links), use_avail_period, avail_from_timestamp, avail_till_timestamp, description, meta_keywords, meta_description, page_title, link (somente para links), seo_name.

Exemplo de requisição

Este exemplo cria uma nova página oculta chamada Test Page com o conteúdo "This is a test page to see how the API works.". O conteúdo usa as tags HTML <p></p>.

bash

curl -u "$EMAIL:$API_KEY" --header 'Content-type: text/plain' -X POST "$BASE_URL/api/2.0/pages" --data-binary 'page_type=T&page=Test Page&status=H&description=<p>This is a test page to see how the API works.</p>'

Resposta

201Página criada

json

{
  "page_id": 226
}

Erros

Status	Quando
`201 Created`	Página criada com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos

Atualizar uma página

PUT/api/2.0/pages/{id}Admin

Atualizar uma página existente com novas propriedades

Parâmetros de caminho

idintegerobrigatório

O identificador único da página a atualizar.

Campos disponíveis: page, parent_id, status, position, timestamp, usergroup_ids, localization, new window (somente para links), use_avail_period, avail_from_timestamp, avail_till_timestamp, description, meta_keywords, meta_description, page_title, link (somente para links), seo_name.

Exemplo de requisição

Este exemplo muda o status da página com page_id=226 para Active (ativa).

bash

curl -u "$EMAIL:$API_KEY" --header 'Content-type: text/plain' -X PUT "$BASE_URL/api/2.0/pages/226" --data-binary 'status=A'

Resposta

200Página atualizada

json

{
  "page_id": 226
}

Excluir uma página

DELETE/api/2.0/pages/{id}Admin

Excluir uma página específica

Parâmetros de caminho

idintegerobrigatório

O identificador único da página a excluir.

Exemplo de requisição

Este exemplo exclui a página com page_id=226.

bash

curl -u "$EMAIL:$API_KEY" -X DELETE "$BASE_URL/api/2.0/pages/226"

Erros

Status	Quando
`204 No Content`	Página excluída com sucesso
`400 Bad Request`	A página não pôde ser excluída
`404 Not Found`	A página não existe

API legada/Referência completa/Páginas

Exemplos de Pages

Uma requisição e uma resposta para cada operação de Pages: listar, obter, criar, atualizar e excluir uma página de conteúdo.

Listar páginas

GET/api/2.0/pagesAdmin

Obter a lista de páginas com suas propriedades

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/pages"

Obter uma página

GET/api/2.0/pages/{id}Admin

Obter os detalhes de uma página específica pelo id

Parâmetros de caminho

idintegerobrigatório

O identificador único da página.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X GET "$BASE_URL/api/2.0/pages/1"

Criar uma página

POST/api/2.0/pagesAdmin

Criar uma nova página

Campos obrigatórios: page_type, page.

Exemplo de requisição

Este exemplo cria uma nova página oculta chamada Test Page com o conteúdo "This is a test page to see how the API works.". O conteúdo usa as tags HTML <p></p>.

bash

curl -u "$EMAIL:$API_KEY" --header 'Content-type: text/plain' -X POST "$BASE_URL/api/2.0/pages" --data-binary 'page_type=T&page=Test Page&status=H&description=<p>This is a test page to see how the API works.</p>'

Resposta

201Página criada

json

{
  "page_id": 226
}

Erros

Status	Quando
`201 Created`	Página criada com sucesso
`400 Bad Request`	Parâmetros da requisição inválidos

Atualizar uma página

PUT/api/2.0/pages/{id}Admin

Atualizar uma página existente com novas propriedades

Parâmetros de caminho

idintegerobrigatório

O identificador único da página a atualizar.

Exemplo de requisição

Este exemplo muda o status da página com page_id=226 para Active (ativa).

bash

curl -u "$EMAIL:$API_KEY" --header 'Content-type: text/plain' -X PUT "$BASE_URL/api/2.0/pages/226" --data-binary 'status=A'

Resposta

200Página atualizada

json

{
  "page_id": 226
}

Excluir uma página

DELETE/api/2.0/pages/{id}Admin

Excluir uma página específica

Parâmetros de caminho

idintegerobrigatório

O identificador único da página a excluir.

Exemplo de requisição

Este exemplo exclui a página com page_id=226.

bash

curl -u "$EMAIL:$API_KEY" -X DELETE "$BASE_URL/api/2.0/pages/226"

Erros

Status	Quando
`204 No Content`	Página excluída com sucesso
`400 Bad Request`	A página não pôde ser excluída
`404 Not Found`	A página não existe