Pular para o conteúdo

API REST

A API deixa um programa seu ler e editar os sites da sua conta. Ela usa o mesmo conteúdo e as mesmas validações do editor, e não gasta crédito de IA.

Como a API e o MCP chegam ao seu site

Um token pessoal dá acesso à API e ao assistente de IA (MCP). As edições passam pela mesma validação do editor.

  1. Abra o site e entre em API no painel.
  2. Clique em Novo token.
  3. Dê um nome ao token (de 2 a 40 letras) e escolha o escopo: Só leitura ou Leitura, edição e publicação.
  4. Clique em Criar token e copie o valor que aparece. Ele começa com epk_ e aparece uma única vez. Depois só se vê o final dele na lista.

Você pode ter até 5 tokens ativos. Eles valem para todos os sites da conta.

Na lista de tokens, clique em Revogar ao lado do token e confirme. Quem usa esse token perde o acesso na hora. A lista mostra o último uso de cada um.

A aba API traz a documentação completa, sempre igual ao que a API faz:

  • Linguagem dos exemplos: escolha cURL, JavaScript (fetch) ou Python; o painel lembra a sua escolha. Cada exemplo já vem com o endereço e o id do site aberto.
  • Endpoints por grupo: clique em um pedido para ver os parâmetros, o exemplo e a resposta, com botão de copiar.
  • Estrutura do site: escolha um bloco (capa, sobre, serviços e os demais) e veja cada campo editável, o tipo, os limites e se é obrigatório, com o botão Copiar bloco. A lista vem do formato real do site, então blocos e campos novos aparecem sozinhos.
  • Copiar para IA: copia a documentação inteira em texto, para colar no seu assistente de IA.
  • Baixar OpenAPI: baixa a especificação (OpenAPI 3.0.3) para usar em Postman, Insomnia ou geradores de código. A mesma especificação fica pública em /api/pages/v1/openapi.json, sem token, e não tem dado de ninguém.

Envie o token no cabeçalho Authorization: Bearer. Só esse cabeçalho vale. O endereço base é https://<seu-endereco>/api/pages/v1; o painel mostra o endereço certo da sua conta.

Janela do terminal
# listar os sites
curl -H "Authorization: Bearer epk_EXEMPLO_NAO_REAL" https://<seu-endereco>/api/pages/v1/sites
# ver um site (o conteúdo vem em "conteudo")
curl -H "Authorization: Bearer epk_EXEMPLO_NAO_REAL" https://<seu-endereco>/api/pages/v1/sites/12
# trocar o nome (versaoBase é a versão que você leu)
curl -X POST \
-H "Authorization: Bearer epk_EXEMPLO_NAO_REAL" \
-H "content-type: application/json" \
-d '{"versaoBase":3,"operacoes":[{"op":"definir","caminho":"/nome","valor":"Ateliê Flor de Sal"}],"resumo":"Troca de nome"}' \
https://<seu-endereco>/api/pages/v1/sites/12/editar
Pedido O que faz Escopo
GET /sites Lista os sites (id, nome, estilo, versão, se está publicado) Leitura
GET /sites/<id> Devolve o conteúdo do site e a versão atual Leitura
GET /esquema Mostra o formato do site e os caminhos permitidos Leitura
GET /sites/<id>/estatisticas?dias=30 Visitas do site Leitura
GET /sites/<id>/atividade Quem fez o quê Leitura
POST /sites/<id>/editar Edita por operações Edição
POST /sites/<id>/publicar Publica a versão informada Edição

A API nunca apaga site e não mexe em plano, domínio, equipe ou cobrança.

Uma edição é uma lista de operações sobre o conteúdo do site. As operações são definir, adicionar, remover e mover, e os caminhos aceitos são /nome, /cores/acento, /seo/titulo, /seo/descricao, /seo/imagem e /blocos/<id> (com campo, índice e subcampo, quando houver). Leia GET /esquema antes de editar.

Informe sempre versaoBase, a versão que você leu. Se o site mudou desde então, a API responde com o erro versao_desatualizada e a versão atual: leia de novo e repita. O servidor recusa tudo que sair do esquema, e sites arquivados não podem ser editados. Cada edição e publicação feita pela API aparece na aba Atividade como “API: nome do token”.

  • Até 120 pedidos por minuto por token (resposta 429 quando passa).
  • Corpo do pedido de até 64 mil caracteres.
  • Publicar pela API segue o mesmo limite do editor: 30 publicações por hora.
  • Token errado, revogado ou de uma conta sem acesso à API recebe sempre a mesma resposta 401.
  • Token de leitura que tenta editar recebe 403.