Automatize o OrbitPage sem compartilhar uma sessão do painel.

Três limites de credenciais abrangem três tarefas diferentes.

Esta página documenta o limite REST versionado. Um token OrbitPage não é uma chave de provedor OpenAI e nunca autentica endpoints de painel privado.

Cada operação de painel suportada, agrupada pela superfície que controla.

Os caminhos abaixo são relativos a https://orbitpage.com/api/v1. Método, caminho e escopo são o contrato de integração estável; esquemas de solicitação, formatos, valores enum e modelos de resposta residem no documento OpenAPI 3.1 vinculado. Rotas desconhecidas retornam 404 e métodos não suportados nunca são convertidos silenciosamente.

Crie um token para uma automação e um ambiente.

Abra Painel > Conta > Tokens de API pessoais. Dê ao token um nome que identifique seu proprietário e finalidade, escolha espaço de trabalho completo, espaço de trabalho somente leitura, somente links ou escopos de recursos individuais e, em seguida, selecione uma expiração de 30, 90 ou 365 dias — ou nenhuma expiração quando já existir um processo de rotação documentado.

export ORBITPAGE_TOKEN='op_pat_...'

curl --silent --show-error --include \
  --header "Authorization: Bearer $ORBITPAGE_TOKEN" \
  https://orbitpage.com/api/v1/links

$env:ORBITPAGE_TOKEN = 'op_pat_...'
$headers = @{ Authorization = "Bearer $env:ORBITPAGE_TOKEN" }

Invoke-RestMethod -Uri 'https://orbitpage.com/api/v1/links' -Headers $headers

Leia a coleção e capture sua revisão antes de cada alteração.

O corpo da resposta contém os blocos ordenados nos dados e a revisão numérica atual. A mesma revisão aparece em X-OrbitPage-Revision e como uma ETag fraca. Salve qualquer valor para If-Match; não adivinhe ou armazene em cache em execuções não relacionadas.

HTTP/2 200
etag: W/"42"
x-orbitpage-revision: 42
content-type: application/json; charset=utf-8

{
  "object": "list",
  "data": [
    {
      "id": "portfolio-main",
      "type": "link",
      "title": "Selected work",
      "description": "Recent projects and case studies",
      "url": "https://example.com/work",
      "isActive": true,
      "status": "live",
      "availability": "available",
      "clickCount": 18,
      "position": 0
    }
  ],
  "revision": 42,
  "workspace": {
    "tenantId": "tenant_...",
    "pageId": "page_...",
    "username": "your-page"
  }
}

Use PATCH para a menor alteração em um bloco existente.

Codifique em URL o ID retornado por GET e envie apenas os campos que devem ser alterados. OrbitPage mescla o patch no bloco existente, protege os campos de identidade e análise, valida a página completa em relação ao seu esquema e plano e publica imediatamente.

curl --request PATCH \
  --url https://orbitpage.com/api/v1/links/portfolio-main \
  --header "Authorization: Bearer $ORBITPAGE_TOKEN" \
  --header 'Content-Type: application/json' \
  --header 'If-Match: W/"42"' \
  --data '{
    "title": "Book a consultation",
    "url": "https://example.com/book",
    "isActive": true
  }'

Use PUT somente quando a própria coleção precisar ser alterada.

PUT substitui a coleção ordenada completa. É a operação para adicionar um bloco, remover um bloco ou alterar a ordem das páginas. Não é um atalho para atualizar um título: omitir um bloco o remove da página.

const token = process.env.ORBITPAGE_TOKEN;
if (!token) throw new Error("ORBITPAGE_TOKEN is missing");

const endpoint = "https://orbitpage.com/api/v1/links";
const authorization = { Authorization: `Bearer ${token}` };

const read = await fetch(endpoint, { headers: authorization });
if (!read.ok) throw new Error(`GET failed: ${read.status} ${await read.text()}`);

const current = await read.json();
const revision = read.headers.get("etag") ?? String(current.revision);

// Preserve the full collection and change only the intended block.
const links = current.data.map((block) =>
  block.id === "portfolio-main"
    ? { ...block, title: "Work and case studies" }
    : block
);

const write = await fetch(endpoint, {
  method: "PUT",
  headers: {
    ...authorization,
    "Content-Type": "application/json",
    "If-Match": revision
  },
  body: JSON.stringify({ links })
});

if (!write.ok) throw new Error(`PUT failed: ${write.status} ${await write.text()}`);
console.log(await write.json());

Use o nó n8n nativo ou o mesmo contrato de um cliente HTTP, cliente gerado, backend ou executor de CI.

OrbitPage não requer um SDK: qualquer cliente HTTPS que possa enviar JSON, autenticação de portador e solicitações GET, POST, PUT, PATCH e DELETE padrão é compatível. Os padrões abaixo cobrem as partes com estado que uma integração deve tratar explicitamente.

Install community node: n8n-nodes-orbitpage

Credential: OrbitPage API
OrbitPage API Token: op_pat_...
OrbitPage Base URL: https://orbitpage.com
Connection test: GET /api/v1/workspace

First safe workflow step:
Node: OrbitPage
Resource: Workspace & Draft
Operation: Get Workspace Overview

First revision-controlled write:
Resource: Theme
Operation: Replace Entire Theme Draft
Revision Check: Use Latest Automatically (Recommended)

# 1. Reserve an upload and receive uploadUrl, slot and uploadToken
POST /api/v1/media/uploads/reserve
{ "filename": "cover.jpg", "contentType": "image/jpeg", "sizeBytes": 245760 }

# 2. Upload the bytes directly using the returned URL, method and headers
# Do not forward the OrbitPage Authorization header to the storage URL.

# 3. Register the uploaded object in the workspace
POST /api/v1/media/uploads/finalize
{ "slot": "<slot>", "uploadToken": "<uploadToken>" }

# 1. Generate a validated preview without changing the page
POST /api/v1/ai/plan
{ "message": "Make the primary CTA clearer" }

# 2. Review the returned operations and previewToken

# 3. Apply the exact reviewed preview; publishing remains explicit
POST /api/v1/ai/commit
{ "previewToken": "<previewToken>", "publish": false }

Leia o guia completo do nó n8n nativo

Trate as credenciais de automação como ciclos de vida curtos e observáveis.

Uma área de trabalho suporta até dez tokens pessoais ativos por usuário. A lista Conta mostra o prefixo, escopos, datas de criação e expiração de cada token e uso recente. Os carimbos de data/hora usados ​​pela última vez são escritos intencionalmente no máximo uma vez a cada cinco minutos.

name: Update OrbitPage
on: workflow_dispatch

jobs:
  update:
    runs-on: ubuntu-latest
    env:
      ORBITPAGE_TOKEN: ${{ secrets.ORBITPAGE_TOKEN }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: node scripts/update-orbitpage.mjs

• Nomeie os tokens por sistema e ambiente — por exemplo, “Ações do GitHub · produção”.
• Faça a rotação criando o substituto, atualizando o armazenamento secreto, testando uma leitura e, em seguida, revogando o token antigo.
• Revogar imediatamente após suspeita de divulgação, mudança de propriedade ou desativação do fluxo de trabalho. A revogação entra em vigor na próxima solicitação.
• Não crie um token compartilhado de longa duração. Credenciais separadas tornam os registros, a rotação e a resposta a incidentes compreensíveis.

Ramificação no status HTTP e código legível por máquina.

Erros usam JSON com erro e código. Não analise a sentença humana para controlar um fluxo de trabalho. A maioria das respostas 4xx exige a alteração da solicitação ou credencial; apenas conflitos de revisão e limites de taxa pertencem a um caminho de nova tentativa automática.

As proteções atuais permitem 120 solicitações por minuto e 5.000 solicitações por dia por token. Os limites podem tornar-se mais rigorosos durante a proteção contra abuso; sempre honre Retry-After.

Uma integração segura é estreita, secreta e reconhece revisão.

A API REST de automação de token pessoal é um recurso SaaS gerenciado.

O repositório de código aberto contém uma API Express usada por seu painel integrado, mas essa API de sessão administrativa interna não é o mesmo contrato de automação com versão. Não envie um token op_pat para um servidor auto-hospedado e não envie um JWT de administrador auto-hospedado para orbitpage.com/api/v1.