Automatisieren Sie OrbitPage, ohne eine Dashboard-Sitzung zu teilen.

Drei Anmeldeinformationsgrenzen decken drei verschiedene Jobs ab.

Diese Seite dokumentiert die versionierte REST-Grenze. Ein OrbitPage-Token ist kein OpenAI-Anbieterschlüssel und authentifiziert niemals private Dashboard-Endpunkte.

Alle unterstützten Dashboard-Vorgänge, gruppiert nach der Oberfläche, die sie steuert.

Die folgenden Pfade beziehen sich auf https://orbitpage.com/api/v1. Methode, Weg und Umfang sind der stabile Integrationsvertrag; Anforderungsschemata, Formate, Aufzählungswerte und Antwortmodelle befinden sich live im verknüpften OpenAPI 3.1-Dokument. Unbekannte Routen geben 404 zurück und nicht unterstützte Methoden werden niemals stillschweigend konvertiert.

Erstellen Sie ein Token für eine Automatisierung und eine Umgebung.

Öffnen Sie Dashboard > Konto > Persönliche API-Tokens. Geben Sie dem Token einen Namen, der seinen Besitzer und Zweck identifiziert, wählen Sie vollständigen Arbeitsbereich, schreibgeschützten Arbeitsbereich, Nur-Links oder einzelne Ressourcenbereiche und wählen Sie dann einen Ablauf von 30, 90 oder 365 Tagen – oder keinen Ablauf, wenn bereits ein dokumentierter Rotationsprozess vorhanden ist.

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

Lesen Sie die Sammlung und erfassen Sie ihre Überarbeitung vor jeder Änderung.

Der Antworttext enthält die geordneten Datenblöcke und die aktuelle numerische Revision. Die gleiche Revision erscheint in X-OrbitPage-Revision und als schwacher ETag. Speichern Sie einen der beiden Werte für If-Match. Raten Sie es nicht und speichern Sie es nicht über unabhängige Läufe hinweg.

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"
  }
}

Verwenden Sie PATCH für die kleinste Änderung an einem vorhandenen Block.

URL-kodieren Sie die von GET zurückgegebene ID und senden Sie nur die Felder, die sich ändern sollen. OrbitPage fügt den Patch in den vorhandenen Block ein, schützt Identitäts- und Analysefelder, validiert die gesamte Seite anhand ihres Schemas und Plans und veröffentlicht sie dann sofort.

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
  }'

Verwenden Sie PUT nur, wenn die Sammlung selbst geändert werden muss.

PUT ersetzt die gesamte geordnete Sammlung. Dabei handelt es sich um den Vorgang zum Hinzufügen eines Blocks, Entfernen eines Blocks oder Ändern der Seitenreihenfolge. Es handelt sich nicht um eine Abkürzung zum Aktualisieren eines Titels: Durch das Weglassen eines Blocks wird dieser von der Seite entfernt.

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());

Verwenden Sie den nativen n8n-Knoten oder denselben Vertrag von einem HTTP-Client, generierten Client, Backend oder CI-Runner.

OrbitPage erfordert kein SDK: Jeder HTTPS-Client, der JSON, Bearer-Authentifizierung und Standard-GET-, POST-, PUT-, PATCH- und DELETE-Anfragen senden kann, ist kompatibel. Die folgenden Muster decken die zustandsbehafteten Teile ab, die eine Integration explizit verarbeiten muss.

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 }

Vollständigen Leitfaden für den nativen n8n-Knoten lesen

Behandeln Sie Automatisierungs-Anmeldeinformationen als kurze, beobachtbare Lebenszyklen.

Ein Arbeitsbereich unterstützt bis zu zehn aktive persönliche Token pro Benutzer. In der Kontoliste werden für jedes Token das Präfix, die Gültigkeitsbereiche, das Erstellungs- und Ablaufdatum sowie die letzte Verwendung angezeigt. Zuletzt verwendete Zeitstempel werden absichtlich höchstens alle fünf Minuten geschrieben.

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

• Benennen Sie Token nach System und Umgebung – zum Beispiel „GitHub Actions · Produktion“.
• Rotieren Sie, indem Sie den Ersatz erstellen, den geheimen Speicher aktualisieren, einen Lesevorgang testen und dann das alte Token widerrufen.
• Sofort nach mutmaßlicher Offenlegung, Eigentümerwechsel oder Einstellung des Arbeitsablaufs widerrufen. Der Widerruf wird mit der nächsten Anfrage wirksam.
• Erstellen Sie kein langlebiges gemeinsames Token. Separate Anmeldeinformationen machen Protokolle, Rotation und Reaktion auf Vorfälle verständlich.

Verzweigung nach HTTP-Status und maschinenlesbarem Code.

Fehler verwenden JSON mit Fehler und Code. Analysieren Sie den menschlichen Satz nicht, um einen Arbeitsablauf zu steuern. Die meisten 4xx-Antworten erfordern eine Änderung der Anfrage oder der Anmeldeinformationen. Nur Revisionskonflikte und Ratenbeschränkungen gehören in einen automatischen Wiederholungspfad.

Aktuelle Leitplanken erlauben 120 Anfragen pro Minute und 5.000 Anfragen pro Tag und Token. Beim Missbrauchsschutz können die Grenzwerte strenger werden; Berücksichtigen Sie immer Retry-After.

Eine sichere Integration ist eng, geheim und revisionsbewusst.

Die Personal-Token-Automation-REST-API ist eine verwaltete SaaS-Funktion.

Das Open-Source-Repository enthält eine Express-API, die von seinem gebündelten Dashboard verwendet wird, aber diese interne Admin-Sitzungs-API ist nicht derselbe versionierte Automatisierungsvertrag. Senden Sie kein op_pat-Token an einen selbstgehosteten Server und kein selbstgehostetes Administrator-JWT an orbitpage.com/api/v1.