VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Páginas

Endpoints de Pages

Todas as URLs da API de Pages com seus métodos, os tipos e status de página e os campos de SEO que você pode preencher.

Esta página lista todas as URLs da API de Pages e o que cada método faz. A referência informa a URL base https://www.venddor.com.br/api/2.0, então a primeira URL abaixo é chamada como $BASE_URL/api/2.0/pages. Use-a para decidir qual chamada você precisa e depois veja os Exemplos para requisições completas.

Todas as páginas

A URL /pages/ obtém todas as páginas de conteúdo ou cria uma nova página.

MétodoDescriçãoUso
GETObtém todas as páginasUse os parâmetros de paginação para limitar o resultado. Veja Paginação e filtros.
POSTCria uma nova páginaExige um corpo JSON com os dados da página.
GET/api/2.0/pagesAdmin

Obter todas as páginas de conteúdo

Parâmetros de consulta

pageintegerpadrão: 1
Número da página na paginação.
items_per_pageintegerpadrão: 10
Quantidade de itens por página.
page_typestring
TFLB
Filtra as páginas por tipo.
statusstring
ADH
Filtra as páginas por status.
qstring
Busca páginas por nome ou conteúdo.

Resposta da listagem

json
{
  "pages": [
    {
      "page_id": 12,
      "page": "About Us",
      "page_type": "T",
      "position": 10,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:15:30Z"
    },
    {
      "page_id": 13,
      "page": "Privacy Policy",
      "page_type": "T",
      "position": 20,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:16:45Z"
    },
    {
      "page_id": 14,
      "page": "Terms of Service",
      "page_type": "T",
      "position": 30,
      "status": "A",
      "parent_id": 0,
      "timestamp": "2025-04-15T10:18:12Z"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 3
  }
}
POST/api/2.0/pagesAdmin

Criar uma nova página de conteúdo

Corpo da requisição

page_titlestringobrigatório
O título da página.
pagestring
O identificador amigável para URL da página (gerado a partir do título se não for informado).
page_typestringpadrão: T
TFL
O tipo da página: T para texto (padrão), F para construtor de formulários, L para link.
parent_idintegerpadrão: 0
Id da página pai (para estrutura hierárquica, 0 para nível superior).
statusstringpadrão: A
ADH
Status da página: A para ativa (padrão), D para desativada, H para oculta.
descriptionstring
Meta descrição da página (para SEO).
contentstring
Conteúdo HTML da página.

Exemplo de criação

A referência mostra dois corpos de requisição para a criação. Este vem da visão geral da seção.

json
{
  "page_title": "Shipping & Delivery",
  "page": "shipping-delivery",
  "page_type": "T",
  "parent_id": "0",
  "status": "A",
  "description": "Information about our shipping and delivery policies",
  "content": "<h1>Shipping & Delivery Policies</h1>\n<p>Our standard shipping time is 2-3 business days...</p>"
}

Este vem da página de URLs.

json
{
  "page": "About Us",
  "page_type": "T",
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p>",
  "meta_description": "Learn about Venddor's history, mission, and team",
  "meta_keywords": "about, company, ecommerce, history, venddor",
  "position": 10,
  "status": "A",
  "company_id": 1,
  "parent_id": 0
}

A visão geral mostra esta resposta para o primeiro corpo.

json
{
  "page_id": "15",
  "company_id": "1",
  "parent_id": "0",
  "page_type": "T",
  "status": "A",
  "position": "0",
  "timestamp": "1617790100",
  "page": "shipping-delivery",
  "page_title": "Shipping & Delivery",
  "description": "Information about our shipping and delivery policies"
}

Uma página específica

A URL /pages/:id trabalha com uma página identificada pelo id.

MétodoDescriçãoUso
GETObtém uma página específicaDevolve as informações detalhadas da página indicada
PUTAtualiza uma páginaExige um corpo JSON com os campos a alterar
DELETEExclui uma páginaRemove a página do sistema de forma permanente
GET/api/2.0/pages/{id}Admin

Obter uma página específica

Parâmetros de caminho

idintegerobrigatório
O identificador único da página a obter.

Resposta do detalhe

json
{
  "page_id": 12,
  "page": "About Us",
  "page_type": "T",
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p>",
  "meta_description": "Learn about Venddor's history, mission, and team",
  "meta_keywords": "about, company, ecommerce, history, venddor",
  "position": 10,
  "status": "A",
  "company_id": 1,
  "parent_id": 0,
  "timestamp": "2025-04-15T10:15:30Z",
  "page_url": "https://www.venddor.com.br/about-us"
}
PUT/api/2.0/pages/{id}Admin

Atualizar uma página de conteúdo existente

Parâmetros de caminho

idintegerobrigatório
O identificador único da página a atualizar.

Você pode atualizar qualquer propriedade da página. Inclua apenas os campos que quer alterar.

Exemplo de atualização

json
{
  "description": "<h1>About Venddor</h1><p>Founded in 2020, Venddor is a leading e-commerce solution provider in Latin America with a focus on innovative retail technologies.</p><p>Our mission is to empower businesses of all sizes to succeed in the digital marketplace through cutting-edge tools and exceptional support.</p><h2>Our Team</h2><p>Our team consists of industry experts with decades of combined experience in retail, technology, and customer service.</p>",
  "meta_description": "Learn about Venddor's history, mission, and expert team members"
}
Dica

Ao atualizar uma página, basta incluir os campos que você quer mudar. Os outros campos mantêm o valor atual. Você pode usar marcação HTML no campo description para formatar o conteúdo: a plataforma aceita as tags HTML padrão, incluindo títulos, parágrafos, listas, tabelas e imagens.

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

Excluir uma página de conteúdo

Parâmetros de caminho

idintegerobrigatório
O identificador único da página a excluir.
Cuidado

Excluir uma página é permanente e não pode ser desfeito. Considere definir o status da página como "Desativada" se você quer apenas retirá-la temporariamente da vista pública.

Tipos de página

Código do tipoDescrição
TPágina de texto: página de conteúdo padrão com texto formatado
FPágina de formulário: página com um formulário para entrada do usuário (exige o add-on Form Builder)
LPágina de link: página que redireciona para uma URL externa
BPágina de blog: página formatada para exibir conteúdo de blog (exige o add-on Blog)

Valores de status da página

StatusDescrição
AAtiva: a página é visível para os usuários
HOculta: a página existe, mas não aparece na navegação
DDesativada: a página está temporariamente desativada
PProtegida por senha: a página exige uma senha para ser acessada

Otimização para SEO

A API de Pages permite otimizar o conteúdo para os buscadores preenchendo estes campos.

CampoDescrição
meta_descriptionDescrição concisa do conteúdo da página (recomendado de 150 a 160 caracteres)
meta_keywordsLista de palavras-chave relevantes para o conteúdo da página, separadas por vírgula
page_titleTítulo (tag title) personalizado da página, se for diferente do nome da página
seo_nameVersão do nome da página amigável para URL, para URLs otimizadas para SEO
Nota

Ao criar ou atualizar páginas com conteúdo HTML, todas as tags HTML precisam estar escapadas corretamente no JSON. A plataforma valida e higieniza o HTML automaticamente para evitar problemas de segurança.

Anterior
Páginas
Próxima
Paginação e filtros
Nesta página
  • Todas as páginas
  • Resposta da listagem
  • Exemplo de criação
  • Uma página específica
  • Resposta do detalhe
  • Exemplo de atualização
  • Tipos de página
  • Valores de status da página
  • Otimização para SEO