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

Páginas de conteúdo

Páginas institucionais da loja (Sobre nós, Trocas, Privacidade), com status, SEO e tradução por idioma.

As páginas de conteúdo são os textos fixos da loja: Sobre nós, Política de troca, Termos de uso, Privacidade. Cada página tem um endereço próprio na vitrine (/{slug}), um título, um corpo em HTML e dados de SEO. Esta seção é a API que o painel usa para criar e manter essas páginas.

Pontos principais
  • Uma página é identificada por UUID e também por slug, o trecho da URL pública.
  • O corpo HTML é sanitizado ao gravar: scripts e atributos de evento são removidos.
  • Apagar é uma exclusão lógica: a página vai para a lixeira e pode ser restaurada.
  • Leitura exige view_content ou manage_content; escrita exige manage_content.
  • Cada página pode ter título e texto próprios por idioma.

Como funciona

Uma página nasce com POST /api/v1/admin/pages, quase sempre já com status active. Daí em diante o painel a edita com PUT, ajusta o texto em outros idiomas pelas rotas de traduções e, quando ela não serve mais, a apaga. A vitrine lê as páginas ativas por uma rota pública própria; esta seção é só a parte administrativa.

Criar→Editar→Traduzir→Apagar
StatusSignificadoAparece na vitrine
activePublicada.Sim
hiddenEscondida do público, mas acessível pelo painel. disabled é gravado do mesmo jeito e volta como hidden.Não
draftRascunho.Não

O tipo (page_type) separa páginas comuns (page), páginas de blog (blog) e atalhos para outro endereço (link).

Conceitos importantes

Slug

O slug é o trecho da URL: a página "Política de Troca" vira /politica-de-troca. Na criação, um slug repetido recebe sufixo (-2, -3). Na atualização, um slug repetido é recusado.

Página da loja e página de seller

Páginas sem vendor_id pertencem à loja inteira. Em lojas com vários sellers, cada seller pode ter páginas próprias que só aparecem na sua vitrine. Use marketplace_only=true ou vendor_id na lista para separar.

Política de privacidade

Se a loja não publicar a própria política, a plataforma serve um texto-modelo. Veja Política de privacidade padrão.

Erros de validação

Esta API devolve 500 em vários casos que seriam 400 ou 404 (status inválido, slug repetido na atualização, id que não é UUID, página inexistente na exclusão). Leia o campo detail da resposta para saber o motivo.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/admin/pagesLista as páginas de conteúdo da lojaadmin
GET/api/v1/admin/pages/{id}Devolve uma página pelo idadmin
POST/api/v1/admin/pagesCria uma página de conteúdoadmin
PUT/api/v1/admin/pages/{id}Altera campos de uma páginaadmin
DELETE/api/v1/admin/pages/{id}Move a página para a lixeiraadmin
GET/api/v1/admin/pages/{id}/descriptionsLista o conteúdo da página em cada idiomaadmin
PUT/api/v1/admin/pages/{id}/descriptionsCria ou atualiza o conteúdo por idiomaadmin
GET/api/v1/admin/pages/privacy-defaultMostra se a loja usa a política padrão e o texto delaadmin

Erros comuns

  • Enviar status fora da lista: a atualização responde 500, e a criação troca silenciosamente o valor por active.
  • Esperar 404 ao apagar uma página que já foi apagada: a resposta é 500 page not found.
  • Mudar o slug de uma página publicada sem redirecionamento: o link antigo para de funcionar.
  • Colocar <script> no corpo: ele é removido sem aviso.
  • Tratar disabled e hidden como estados diferentes: são o mesmo e a leitura devolve hidden.
  • Usar os campos que repetem outros valores (page_id, description...) em integrações novas.

Próximos passos

Listar páginas
Filtros e paginação.
Criar página
Slug, status e SEO.
Traduções
Conteúdo por idioma.
Anterior
Cobertura e revisão
Próxima
Listar páginas
Nesta página
  • Como funciona
  • Conceitos importantes
  • Slug
  • Página da loja e página de seller
  • Política de privacidade
  • Erros de validação
  • Endpoints
  • Erros comuns
  • Próximos passos