أتمتة OrbitPage دون مشاركة جلسة لوحة المعلومات.

ثلاثة حدود لبيانات الاعتماد تغطي ثلاث وظائف مختلفة.

توثق هذه الصفحة حدود REST التي تم إصدارها. رمز OrbitPage ليس مفتاح موفر OpenAI ولا يقوم مطلقًا بتوثيق نقاط نهاية لوحة المعلومات الخاصة.

كل عملية مدعومة من لوحة المعلومات، مجمعة حسب السطح الذي تتحكم فيه.

المسارات أدناه مرتبطة بـ https://orbitpage.com/api/v1. الطريقة والمسار والنطاق هي عقد التكامل المستقر؛ توجد مخططات الطلب والتنسيقات وقيم التعداد ونماذج الاستجابة في مستند OpenAPI 3.1 المرتبط. تقوم المسارات غير المعروفة بإرجاع 404 ولا يتم أبدًا تحويل الطرق غير المدعومة بصمت.

قم بإنشاء رمز مميز واحد لأتمتة واحدة وبيئة واحدة.

افتح لوحة التحكم > الحساب > الرموز المميزة لواجهة برمجة التطبيقات الشخصية. قم بتسمية الرمز المميز الذي يحدد مالكه والغرض منه، واختر مساحة عمل كاملة، أو مساحة عمل للقراءة فقط، أو روابط فقط أو نطاقات موارد فردية، ثم حدد انتهاء صلاحية لمدة 30 أو 90 أو 365 يومًا - أو عدم انتهاء الصلاحية عندما تكون عملية التناوب الموثقة موجودة بالفعل.

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

اقرأ المجموعة والتقط مراجعتها قبل كل تغيير.

يحتوي نص الاستجابة على الكتل المطلوبة في البيانات والمراجعة الرقمية الحالية. تظهر نفس المراجعة في X-OrbitPage-Revision وكعلامة ETag ضعيفة. احفظ أيًا من القيمتين لـ If-Match؛ لا تقم بتخمينه أو تخزينه مؤقتًا عبر عمليات تشغيل غير ذات صلة.

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

استخدم PATCH لإجراء أصغر تغيير على كتلة موجودة.

يقوم عنوان URL بتشفير المعرف الذي تم إرجاعه بواسطة GET وإرسال الحقول التي يجب تغييرها فقط. تقوم OrbitPage بدمج التصحيح في الكتلة الموجودة، وحماية حقول الهوية والتحليلات، والتحقق من صحة الصفحة الكاملة مقابل مخططها وخطتها، ثم نشرها على الفور.

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 فقط عندما يجب تغيير المجموعة نفسها.

يستبدل PUT المجموعة الكاملة المطلوبة. إنها عملية إضافة كتلة أو إزالة كتلة أو تغيير ترتيب الصفحات. إنه ليس اختصارًا لتحديث عنوان واحد: فحذف كتلة يؤدي إلى إزالتها من الصفحة.

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

استخدم عقدة n8n الأصلية أو نفس العقد من عميل HTTP أو العميل الذي تم إنشاؤه أو الواجهة الخلفية أو مشغل CI.

لا يتطلب OrbitPage SDK: أي عميل HTTPS يمكنه إرسال JSON ومصادقة Bearer وطلبات GET وPOST وPUT وPATCH وDELETE القياسية متوافقة. تغطي الأنماط الموجودة أدناه الأجزاء ذات الحالة التي يجب أن يتعامل معها التكامل بشكل صريح.

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 }

اقرأ الدليل الكامل لعقدة n8n الأصلية

تعامل مع بيانات اعتماد التشغيل الآلي باعتبارها دورات حياة قصيرة ويمكن ملاحظتها.

تدعم مساحة العمل ما يصل إلى عشرة رموز شخصية نشطة لكل مستخدم. تعرض قائمة الحساب بادئة كل رمز مميز، ونطاقاته، وتواريخ الإنشاء وانتهاء الصلاحية، والاستخدام الأخير. تتم كتابة الطوابع الزمنية الأخيرة المستخدمة عمدًا مرة واحدة على الأكثر كل خمس دقائق.

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

• قم بتسمية الرموز المميزة حسب النظام والبيئة - على سبيل المثال، "GitHub Actions · production".
• قم بالتدوير عن طريق إنشاء البديل، وتحديث المتجر السري، واختبار قراءة واحدة، ثم إلغاء الرمز القديم.
• يتم الإلغاء فورًا بعد الإفصاح المشتبه به أو تغيير الملكية أو التقاعد عن سير العمل. يسري مفعول الإلغاء عند الطلب التالي.
• لا تقم بإنشاء رمز مميز مشترك طويل الأمد. بيانات الاعتماد المنفصلة تجعل السجلات والتناوب والاستجابة للحوادث مفهومة.

فرع على حالة HTTP والتعليمات البرمجية القابلة للقراءة آليًا.

تستخدم الأخطاء JSON مع الخطأ والرمز. لا تقم بتحليل الجملة البشرية للتحكم في سير العمل. تتطلب معظم استجابات 4xx تغيير الطلب أو بيانات الاعتماد؛ فقط تعارضات المراجعة وحدود المعدل تنتمي إلى مسار إعادة المحاولة التلقائي.

تسمح الحدود الحالية بـ 120 طلبًا في الدقيقة و5000 طلب يوميًا لكل رمز. قد تنخفض الحدود أثناء الحماية من إساءة الاستخدام؛ التزم دائمًا بـ Retry-After.

التكامل الآمن يكون ضيقًا وسريًا وقابلاً للمراجعة.

تعد واجهة Automation REST API للرمز الشخصي إحدى إمكانيات SaaS المُدارة.

يتضمن المستودع مفتوح المصدر Express API تستخدمها لوحة المعلومات المرفقة، لكن API جلسة المسؤول الداخلية ليست عقد الأتمتة نفسه ذي الإصدارات. لا ترسل رمز op_pat إلى خادم self-hosted ولا ترسل JWT لمسؤول self-hosted إلى orbitpage.com/api/v1.