OrbitPage'i bir kontrol paneli oturumunu paylaşmadan otomatikleştirin.

Üç kimlik bilgisi sınırı üç farklı işi kapsar.

Bu sayfa sürümlendirilmiş REST sınırını belgelemektedir. OrbitPage belirteci bir OpenAI sağlayıcı anahtarı değildir ve hiçbir zaman özel kontrol paneli uç noktalarının kimliğini doğrulamaz.

Kontrol ettiği yüzeye göre gruplandırılmış, desteklenen her kontrol paneli işlemi.

Aşağıdaki yollar https://orbitpage.com/api/v1 ile ilişkilidir. Yöntem, yol ve kapsam istikrarlı entegrasyon sözleşmesidir; istek şemaları, formatları, numaralandırma değerleri ve yanıt modelleri bağlantılı OpenAPI 3.1 belgesinde mevcuttur. Bilinmeyen rotalar 404 değerini döndürür ve desteklenmeyen yöntemler hiçbir zaman sessizce dönüştürülmez.

Bir otomasyon ve bir ortam için bir belirteç oluşturun.

Kontrol Paneli > Hesap > Kişisel API belirteçlerini açın. Belirteci sahibini ve amacını tanımlayan bir ad verin, tam çalışma alanını, salt okunur çalışma alanını, salt bağlantıları veya bireysel kaynak kapsamlarını seçin, ardından 30, 90 veya 365 günlük bir sona erme tarihi seçin veya belgelenmiş bir rotasyon süreci zaten mevcut olduğunda sona erme olmamasını seçin.

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

Koleksiyonu okuyun ve her değişiklikten önce revizyonunu kaydedin.

Yanıt gövdesi, verilerdeki sıralı blokları ve geçerli sayısal revizyonu içerir. Aynı revizyon X-OrbitPage-Revision'da ve zayıf bir ETag olarak görünüyor. If-Match için iki değerden birini kaydedin; ilgisiz çalıştırmalarda tahmin etmeyin veya önbelleğe almayın.

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

Mevcut bir blokta yapılacak en küçük değişiklik için PATCH'i kullanın.

GET tarafından döndürülen kimliği URL olarak kodlayın ve yalnızca değişmesi gereken alanları gönderin. OrbitPage yamayı mevcut blokla birleştirir, kimlik ve analiz alanlarını korur, sayfanın tamamını şema ve planına göre doğrular ve ardından hemen yayınlar.

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

PUT'u yalnızca koleksiyonun kendisinin değişmesi gerektiğinde kullanın.

PUT, sipariş edilen koleksiyonun tamamının yerini alır. Blok ekleme, blok kaldırma veya sayfa sırasını değiştirme işlemidir. Bu, bir başlığı güncellemenin kısayolu değildir: bir bloğun atlanması, onu sayfadan kaldırır.

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

Yerel n8n düğümünü veya bir HTTP istemcisinden, oluşturulan istemciden, arka uçtan veya CI çalıştırıcısından gelen aynı sözleşmeyi kullanın.

OrbitPage bir SDK gerektirmez: JSON, Taşıyıcı kimlik doğrulaması ve standart GET, POST, PUT, PATCH ve DELETE isteklerini gönderebilen herhangi bir HTTPS istemcisi uyumludur. Aşağıdaki modeller, bir entegrasyonun açıkça ele alması gereken durum bilgisi olan parçaları kapsar.

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 }

Yerel n8n düğüm kılavuzunun tamamını okuyun

Otomasyon kimlik bilgilerini kısa, gözlemlenebilir yaşam döngüleri olarak değerlendirin.

Bir çalışma alanı, kullanıcı başına en fazla on aktif kişisel belirteci destekler. Hesap listesi her tokenın önekini, kapsamlarını, oluşturulma ve son kullanma tarihlerini ve son kullanımını gösterir. Son kullanılan zaman damgaları en fazla beş dakikada bir kasıtlı olarak yazılır.

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

• Belirteçleri sisteme ve ortama göre adlandırın; örneğin, "GitHub Eylemleri · üretim".
• Değiştirmeyi oluşturarak, gizli depoyu güncelleyerek, bir okumayı test ederek ve ardından eski jetonu iptal ederek rotasyon yapın.
• Şüphelenilen ifşadan, sahiplik değişikliğinden veya iş akışının kullanımdan kaldırılmasından hemen sonra iptal edin. İptal, bir sonraki talepte geçerli olur.
• Uzun ömürlü, paylaşılan bir belirteç oluşturmayın. Ayrı kimlik bilgileri günlükleri, rotasyonu ve olay müdahalesini anlaşılır hale getirir.

HTTP durumu ve makine tarafından okunabilen koddaki dallanma.

Hatalar, hata ve kodla birlikte JSON'u kullanır. Bir iş akışını kontrol etmek için insan cümlesini ayrıştırmayın. Çoğu 4xx yanıtı, isteğin veya kimlik bilgilerinin değiştirilmesini gerektirir; yalnızca revizyon çakışmaları ve hız sınırları otomatik yeniden deneme yoluna aittir.

Mevcut sınırlar token başına dakikada 120, günde 5.000 isteğe izin verir. Kötüye kullanım koruması sırasında sınırlar düşebilir; Retry-After değerine her zaman uyun.

Güvenli bir entegrasyon dar, gizli ve revizyona duyarlıdır.

Kişisel belirteç Otomasyonu REST API, yönetilen bir SaaS yeteneğidir.

Açık kaynak deposu, birlikte gelen kontrol panelinin kullandığı bir Express API içerir; ancak bu dahili yönetici oturumu API'si aynı sürümlü otomasyon sözleşmesi değildir. op_pat token'ını self-hosted sunucuya, self-hosted yönetici JWT'sini ise orbitpage.com/api/v1 adresine göndermeyin.