Páginas

Páginas são o conteúdo da loja que não é produto: "Quem somos", "Termos e condições", "Política de privacidade" e semelhantes. A API de Pages permite criar, consultar, atualizar e excluir essas páginas de conteúdo, incluindo o HTML e os campos de SEO. Use-a para manter o conteúdo institucional sincronizado com outro sistema ou para publicar muitas páginas sem passar pelo painel de administração.

Toda chamada usa as credenciais HTTP Basic de um administrador ($EMAIL:$API_KEY) e o endereço da sua loja ($BASE_URL), então os endpoints abaixo aparecem como $BASE_URL/api/2.0/pages.

Como funciona

1. Crie a página
   Envie um POST com o título (page_title ou page), o tipo e o conteúdo HTML. A resposta traz o id da nova página.
2. Controle a visibilidade
   Defina o status: páginas ativas são públicas, páginas ocultas existem mas ficam fora da navegação, páginas desativadas não aparecem para os clientes.
3. Mantenha a página
   Leia-a de volta com um GET, altere só os campos necessários com um PUT e organize as páginas em hierarquia com parent_id.

Tipos de página

Status da página

A página de endpoints da referência lista também o código P (protegida por senha: a página exige uma senha para ser acessada). Veja Endpoints.

Conceitos principais

Parâmetros de consulta da listagem

A visão geral descreve GET /pages com estes parâmetros de consulta opcionais.

A visão geral mostra esta resposta de listagem. A página Paginação e filtros traz o conjunto completo de parâmetros.

{
  "pages": [
    {
      "page_id": "10",
      "company_id": "1",
      "parent_id": "0",
      "page_type": "T",
      "status": "A",
      "position": "0",
      "timestamp": "1617789245",
      "page": "about",
      "page_title": "About Us",
      "description": "Learn more about our company and mission"
    },
    {
      "page_id": "12",
      "company_id": "1",
      "parent_id": "0",
      "page_type": "T",
      "status": "A",
      "position": "10",
      "timestamp": "1617789300",
      "page": "terms",
      "page_title": "Terms and Conditions",
      "description": "Our store terms and conditions"
    }
  ]
}

Criação e atualização

Para criar uma página, a visão geral exige page_title e aceita page (o identificador amigável para URL, gerado a partir do título se você não informar), page_type (padrão T), parent_id (0 para nível superior), status (padrão A), description (a meta descrição, para SEO) e content (o conteúdo HTML). Para atualizar, você pode enviar qualquer uma dessas propriedades, e só as que quer mudar.

Endpoints

A página Exemplos mostra uma requisição e uma resposta para cada um.

Erros comuns

• Definir parent_id com algo que não é uma página. Use o id de uma página existente, ou 0 para uma página de nível superior.
• Excluir uma página que você só quer esconder. A exclusão é permanente; mude o status para D.
• Enviar HTML cru em um corpo JSON sem escapar. Todas as tags HTML precisam estar escapadas corretamente no JSON.
• Criar uma página de formulário ou de blog sem o add-on de que ela depende.
• Esperar a página inteira de volta em um PUT. Os exemplos devolvem apenas o id da página.

Próximos passos