Automatiseer OrbitPage zonder een dashboardsessie te delen.

Drie referentiegrenzen bestrijken drie verschillende banen.

Deze pagina documenteert de REST-grens met versiebeheer. Een OrbitPage-token is geen OpenAI-providersleutel en verifieert nooit eindpunten van privédashboards.

Elke ondersteunde dashboardbewerking, gegroepeerd op het oppervlak dat erdoor wordt bestuurd.

De onderstaande paden zijn relatief ten opzichte van https://orbitpage.com/api/v1. Methode, pad en reikwijdte vormen het stabiele integratiecontract; verzoekschema's, formaten, opsommingswaarden en responsmodellen staan ​​live in het gekoppelde OpenAPI 3.1-document. Onbekende routes retourneren 404 en niet-ondersteunde methoden worden nooit stilzwijgend geconverteerd.

Creëer één token voor één automatisering en één omgeving.

Open Dashboard > Account > Persoonlijke API-tokens. Geef het token een naam die de eigenaar en het doel ervan identificeert, kies een volledige werkruimte, een alleen-lezen werkruimte, alleen links of individuele resourcebereiken en selecteer vervolgens een vervaldatum van 30, 90 of 365 dagen, of geen vervaldatum als er al een gedocumenteerd rotatieproces bestaat.

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

Lees de collectie en leg de revisie ervan vast vóór elke wijziging.

De antwoordtekst bevat de geordende blokken in gegevens en de huidige numerieke revisie. Dezelfde revisie verschijnt in X-OrbitPage-Revision en als een zwakke ETag. Bewaar beide waarden voor If-Match; raad het niet en cache het niet in niet-gerelateerde runs.

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

Gebruik PATCH voor de kleinste wijziging aan een bestaand blok.

URL-codeer de ID die door GET wordt geretourneerd en verzend alleen de velden die moeten veranderen. OrbitPage voegt de patch samen met het bestaande blok, beschermt identiteits- en analysevelden, valideert de volledige pagina aan de hand van het schema en plan en publiceert vervolgens onmiddellijk.

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

Gebruik PUT alleen als de collectie zelf moet veranderen.

PUT vervangt de volledige bestelde collectie. Het is de handeling voor het toevoegen van een blok, het verwijderen van een blok of het wijzigen van de paginavolgorde. Het is geen snelkoppeling voor het bijwerken van één titel: als u een blok weglaat, wordt het van de pagina verwijderd.

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

Gebruik het native n8n-knooppunt of hetzelfde contract van een HTTP-client, gegenereerde client, backend of CI-runner.

OrbitPage vereist geen SDK: elke HTTPS-client die JSON, Bearer-authenticatie en standaard GET-, POST-, PUT-, PATCH- en DELETE-verzoeken kan verzenden, is compatibel. De onderstaande patronen bestrijken de stateful delen die een integratie expliciet moet verwerken.

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 }

Lees de volledige handleiding voor native n8n-knooppunten

Beschouw automatiseringsreferenties als korte, waarneembare levenscycli.

Een werkruimte ondersteunt maximaal tien actieve persoonlijke tokens per gebruiker. De accountlijst toont het voorvoegsel, het bereik, de aanmaak- en vervaldatums en het recente gebruik van elk token. Laatstgebruikte tijdstempels worden opzettelijk maximaal één keer per vijf minuten geschreven.

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

• Geef tokens een naam op systeem en omgeving, bijvoorbeeld "GitHub-acties · productie".
• Roteer door de vervanging te maken, de geheime opslag bij te werken, één leesbewerking te testen en vervolgens het oude token in te trekken.
• Intrekken onmiddellijk na vermoedelijke openbaarmaking, eigendomswijziging of intrekking van de workflow. De intrekking wordt van kracht bij het eerstvolgende verzoek.
• Bouw geen gedeeld token met een lange levensduur. Afzonderlijke inloggegevens maken logboeken, rotatie en incidentrespons begrijpelijk.

Vertakking op de HTTP-status en machineleesbare code.

Fouten gebruiken JSON met fout en code. Ontleed de menselijke zin niet om een ​​workflow te controleren. Voor de meeste 4xx-reacties is het wijzigen van het verzoek of de inloggegevens vereist; alleen revisieconflicten en snelheidslimieten horen thuis in een automatisch opnieuw proberen-pad.

De huidige vangrails staan ​​120 verzoeken per minuut en 5.000 verzoeken per dag per token toe. Grenzen kunnen strenger worden tijdens bescherming tegen misbruik; respecteer altijd Retry-After.

Een veilige integratie is smal, geheim en revisiebewust.

De persoonlijke token Automation REST API is een beheerde SaaS-mogelijkheid.

De open-source repository bevat een Express API die wordt gebruikt door het gebundelde dashboard, maar die interne beheerderssessie-API is niet hetzelfde automatiseringscontract met versiebeheer. Stuur geen op_pat-token naar een zelf-gehoste server en stuur geen zelf-gehoste admin-JWT naar orbitpage.com/api/v1.