Automatisez OrbitPage sans partager une session de tableau de bord.

Trois limites de titres de compétences couvrent trois emplois différents.

Cette page documente la limite REST versionnée. Un jeton OrbitPage n'est pas une clé de fournisseur OpenAI et n'authentifie jamais les points de terminaison du tableau de bord privé.

Chaque opération de tableau de bord prise en charge, regroupée en fonction de la surface qu'elle contrôle.

Les chemins ci-dessous sont relatifs à https://orbitpage.com/api/v1. La méthode, le chemin et la portée constituent le contrat d'intégration stable ; les schémas de requête, les formats, les valeurs d'énumération et les modèles de réponse se trouvent dans le document OpenAPI 3.1 lié. Les routes inconnues renvoient 404 et les méthodes non prises en charge ne sont jamais converties en silence.

Créez un jeton pour une automatisation et un environnement.

Ouvrez le tableau de bord > Compte > Jetons d'API personnels. Donnez au jeton un nom qui identifie son propriétaire et son objectif, choisissez un espace de travail complet, un espace de travail en lecture seule, des liens uniquement ou des étendues de ressources individuelles, puis sélectionnez une expiration de 30, 90 ou 365 jours, ou aucune expiration lorsqu'un processus de rotation documenté existe déjà.

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

Lisez la collection et capturez sa révision avant chaque modification.

Le corps de la réponse contient les blocs ordonnés dans les données et la révision numérique actuelle. La même révision apparaît dans X-OrbitPage-Revision et sous forme d'ETag faible. Enregistrez l'une ou l'autre valeur pour If-Match ; ne le devinez pas et ne le mettez pas en cache sur des exécutions non liées.

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

Utilisez PATCH pour la plus petite modification apportée à un bloc existant.

Encodez en URL l'ID renvoyé par GET et envoyez uniquement les champs qui doivent changer. OrbitPage fusionne le correctif dans le bloc existant, protège les champs d'identité et d'analyse, valide la page complète par rapport à son schéma et son plan, puis publie immédiatement.

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

Utilisez PUT uniquement lorsque la collection elle-même doit changer.

PUT remplace la collection complète ordonnée. Il s'agit de l'opération permettant d'ajouter un bloc, de supprimer un bloc ou de modifier l'ordre des pages. Il ne s'agit pas d'un raccourci pour mettre à jour un titre : omettre un bloc le supprime de la page.

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

Utilisez le nœud n8n natif ou le même contrat à partir d'un client HTTP, d'un client généré, d'un backend ou d'un exécuteur CI.

OrbitPage ne nécessite pas de SDK : tout client HTTPS capable d'envoyer du JSON, de l'authentification Bearer et des requêtes standards GET, POST, PUT, PATCH et DELETE est compatible. Les modèles ci-dessous couvrent les parties avec état qu'une intégration doit gérer explicitement.

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 }

Lire le guide complet des nœuds n8n natifs

Traitez les informations d'identification d'automatisation comme des cycles de vie courts et observables.

Un espace de travail prend en charge jusqu'à dix jetons personnels actifs par utilisateur. La liste des comptes affiche le préfixe, les étendues, les dates de création et d'expiration de chaque jeton, ainsi que son utilisation récente. Les horodatages de dernière utilisation sont intentionnellement écrits au maximum une fois toutes les cinq minutes.

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

• Nommez les jetons par système et environnement, par exemple « Actions GitHub · production ».
• Effectuez une rotation en créant le remplacement, en mettant à jour le magasin secret, en testant une lecture, puis en révoquant l'ancien jeton.
• Révoquer immédiatement après une divulgation suspectée, un changement de propriétaire ou un retrait du flux de travail. La révocation prend effet à la prochaine demande.
• Ne créez pas de jeton partagé de longue durée. Des informations d'identification distinctes rendent les journaux, la rotation et la réponse aux incidents compréhensibles.

Branche sur le statut HTTP et le code lisible par machine.

Les erreurs utilisent JSON avec l'erreur et le code. N'analysez pas la phrase humaine pour contrôler un flux de travail. La plupart des réponses 4xx nécessitent de modifier la demande ou les informations d'identification ; seuls les conflits de révision et les limites de débit appartiennent à un chemin de nouvelle tentative automatique.

Les garde-fous actuels autorisent 120 requêtes par minute et 5 000 requêtes par jour et par jeton. Les limites peuvent devenir plus strictes pendant la protection contre les abus ; honorez toujours Retry-After.

Une intégration sécurisée est étroite, secrète et sensible aux révisions.

L'API REST Automation à jeton personnel est une fonctionnalité SaaS gérée.

Le référentiel open source contient une API Express utilisée par son tableau de bord fourni, mais cette API de session d'administration interne n'est pas le même contrat d'automatisation versionné. N'envoyez pas de jeton op_pat à un serveur auto-hébergé et n'envoyez pas de JWT d'administrateur auto-hébergé à orbitpage.com/api/v1.