オートメーション REST API

ダッシュボード セッションを共有せずに OrbitPage を自動化します。

スコープ付きトークンを作成し、スクリプト、n8n、バックエンド、または CI から OrbitPage ダッシュボードをエンドツーエンドで管理します。

最新リビジョン: 2026年8月4日

権限を絞った個人トークンで OrbitPage ワークスペースを管理し、ページの編集・公開、メディア、ドメイン、分析、AI、Shop、ニュースレター、請求を利用できます。

API v1https://orbitpage.com/api/v1HTTPS · JSON · UTF-8
  1. 01個人トークン
  2. 02リビジョンチェック
  3. 03検証して公開する
API 境界

3 つの資格情報境界が 3 つの異なるジョブをカバーします。

このページでは、バージョン管理された REST 境界について説明します。 OrbitPage トークンは OpenAI プロバイダー キーではなく、プライベート ダッシュボード エンドポイントを認証することはありません。

表面資格情報目的とサポート
オートメーション REST APIop_pat_...スクリプト、n8n、サーバー バックエンド、CI の外部 API をサポートしました。 /api/v1 を通じてトークン バインドされたワークスペースを管理します。
OrbitPage AIop_pat_... + ai:read/ai:write公開プラン/コミット フローは、検証済みの AI 提案を準備して適用します。 OpenAI プロバイダーの資格情報はサーバー側で個別に考慮されるため、OrbitPage ベアラー トークンになることはありません。
ダッシュボード APISaaS 上の Firebase セッション。 OSS の管理者セッションブラウザーからアプリへのプライベート ルート。これらは安定した外部統合契約ではないため、個人用 API トークンを受け取ることはできません。
契約

バージョン管理されたリソースはダッシュボードをカバーします。リンク エンドポイントは安全な更新ループを示します。

すべてのリクエストは、トークンの作成時に選択されたワークスペースにバインドされます。トークンは URL またはリクエスト本文で別のテナントを選択できず、呼び出しごとに現在のワークスペース権限が再チェックされます。

このコントラクトは、標準の HTTPS JSON 操作 (GET、POST、PUT、PATCH、および DELETE) を使用し、curl、n8n の HTTP リクエスト ノード、および生成された OpenAPI クライアントをサポートします。

01
GET/api/v1/links

ページブロックごとに読み取ります

順序付けられたコレクション、ワークスペース ID、および現在のリビジョンを返します。

範囲: links:read
02
PATCH/api/v1/links/{linkId}

既存のブロックを 1 つ変更します

編集可能なフィールドを結合し、ページ全体を検証し、新しいリビジョンを公開します。

範囲: links:write
03
PUT/api/v1/links

コレクション全体を置き換えます

現在のコレクションを読み取って保存した後、これを使用してブロックを追加、削除、または並べ替えます。

範囲: links:write
ダッシュボード表面API パススコープ
ワークスペースと完全なドラフト/workspace · /draftworkspace:read
プロフィール、テーマ、サブページ/profile · /theme · /pagesprofile:* · theme:* · pages:*
一般、プライバシー、メニュー設定/settings/*settings:*
出版物、バージョン、バックアップ/publication · /versions · /backuppublication:* · backup:*
メディアとカスタム ドメイン/media/* · /domains/*media:* · domains:*
分析と AI の変更のレビュー/analytics · /ai/*analytics:read · ai:*
ショップとニュースレター/shop/* · /newsletter/*shop:* · newsletter:*
チームと請求/team/* · /billing/*team:* · billing:*
OpenAPI 3.1 仕様を開く
API v1 · 65 オペレーション

サポートされているすべてのダッシュボード操作は、制御するサーフェスごとにグループ化されています。

以下のパスは https://orbitpage.com/api/v1 に対する相対パスです。メソッド、パス、スコープは安定した統合契約です。リクエストのスキーマ、形式、列挙値、および応答モデルは、リンクされた OpenAPI 3.1 ドキュメント内に存在します。不明なルートは 404 を返し、サポートされていないメソッドはサイレントに変換されません。

01
ワークスペース、コンテンツ、外観トークン バインドされたワークスペースを検査し、その完全なドラフト、プロファイル、ブロック、テーマ、サブページを管理します。
11 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/workspaceワークスペース、計画、アクセス、使用法、リビジョンの読み取りworkspace:read
GET/draft編集可能なページの完全なドラフトを読むworkspace:read
GET/linksページブロックと現在のリビジョンをリストします。links:read
PUT/links完全な順序付きブロック コレクションを置き換えますlinks:writeLinksReplaceRequest · If-Match
PATCH/links/{linkId}1 つのブロック上の編集可能なフィールドを更新しますlinks:writeLinkPatch · If-Match
GET/profileプロファイル ID とメタデータの読み取りprofile:read
PATCH/profileプロフィールフィールドを更新するprofile:writeJSON · If-Match · ?publish=1
GET/themeアクティブなドラフトテーマを読むtheme:read
PUT/themeドラフトテーマを置き換えますtheme:writeJSON · If-Match · ?publish=1
GET/pages構成されたサブページのリストを表示しますpages:read
PUT/pages設定されたサブページを置き換えますpages:writearray | { pages } · If-Match · ?publish=1
02
設定と公開メニュー、プライバシー、管理された公開ファイル、サイトマップの生成、および明示的なドラフトから公開までのライフサイクルを制御します。
9 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/settingsメニュー、プライバシー、テキスト ファイル、サイトマップ設定の読み取りsettings:read
PUT/settings/menuメニュー設定を更新するsettings:writeJSON · If-Match · ?publish=1
PUT/settings/privacy同意とプライバシーの設定を更新するsettings:writeJSON · If-Match · ?publish=1
POST/settings/text-files管理された公開テキスト ファイルを作成するsettings:writeTextFileCreateRequest · If-Match
PUT/settings/text-files/{key}管理された公開テキスト ファイルを更新するsettings:writeTextFileUpdateRequest · If-Match
DELETE/settings/text-files/{key}管理されたパブリック テキスト ファイルを削除しますsettings:writeIf-Match
POST/settings/sitemap管理対象サイトマップを再生成するsettings:writeIf-Match
GET/publicationドラフトと出版ステータスを読むpublication:read
POST/publication最新の検証済みドラフトを公開するpublication:write
03
バージョン、バックアップ、メディアリビジョンされたコンテンツを復元し、ワークスペース データをエクスポートまたはインポートし、メディアの予約、アップロード、ファイナライズのライフサイクルを実行します。
9 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/versions復元可能な公開ページのバージョンをリストするbackup:read
POST/versions/{revision}/restore過去のバージョンを復元して直ちに公開するbackup:writeIf-Match
GET/backup管理対象ワークスペースのバックアップをエクスポートするbackup:read?sections=profile,links,…
POST/backup/restore管理対象のバックアップを検証・復元し、直ちに公開するbackup:writeBackupRestoreRequest · If-Match
GET/mediaワークスペースのメディアのメタデータと使用状況をリストするmedia:read
POST/media/cleanup参照されていないメディアをプレビューまたは削除するmedia:writeMediaCleanupRequest
POST/media/uploads/reserveメディアの直接アップロードを予約するmedia:writeMediaUploadReserveRequest
POST/media/uploads/finalizeアップロードされたオブジェクトを完成させて登録するmedia:writeUploadTokenRequest
DELETE/media/uploads予約されたメディアのアップロードを中止しますmedia:writeUploadTokenRequest
04
ドメイン、分析、AIDNS アクティベーションを管理し、プラン限定のパフォーマンス レポートを読み取り、検証されたプレビュー後にのみ AI の変更を適用します。
8 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/domainsドメインのステータスと DNS 要件を読み取るdomains:read
POST/domainsカスタム ドメインを接続するdomains:writeDomainConnectRequest
POST/domains/refreshリフレッシュの検証とアクティブ化domains:write
DELETE/domainsカスタム ドメインを切断しますdomains:write
GET/analyticsダッシュボード分析レポートを読むanalytics:read?days=7|30|90
GET/ai/allowanceAI の許容量と現在の使用量を読み取るai:read
POST/ai/plan検証済みの AI 変更プレビューを生成するai:writeAiPlanRequest
POST/ai/commit以前に検証された AI プレビューをコミットするai:writeAiCommitRequest
05
Shopコマースを接続し、製品と外観を管理し、保護されたファイルをアップロードしてから、同期されたショップ ブロックを公開または非公開にします。
10 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/shop製品、注文、顧客、Shop の状態を読み取る。この操作は Shop の非公開データを初期化し、Stripe の状態を更新する場合がありますshop:read?refresh=0|1
POST/shop/connectStripe Connect オンボーディングの作成または継続shop:write
POST/shop/productsショップ製品を作成または更新するshop:writeShopProductRequest
DELETE/shop/products/{productId}ショップ製品を削除するshop:write
PUT/shop/appearanceショップの外観全体を置き換えるshop:writeShopAppearanceRequest
POST/shop/publishShop と同期ページブロックを公開shop:write
POST/shop/unpublishショップを非公開にするshop:write
POST/shop/uploads/reserve製品ファイルのアップロードを予約するshop:writeShopFileUploadReserveRequest
POST/shop/uploads/finalize製品ファイルのアップロードを完了するshop:writeShopUploadTokenRequest
DELETE/shop/uploads予約済みの商品ファイルのアップロードを中止shop:writeShopUploadTokenRequest
06
ニュースレター暗号化された SMTP 配信を構成し、同意した加入者を管理し、キャンペーンのライフサイクル全体を制御します。
9 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/newsletterサブスクライバー、キャンペーン、SMTP 状態の読み取りnewsletter:read
PUT/newsletter/settings暗号化された SMTP 設定を更新しますnewsletter:writeNewsletterSmtpRequest
POST/newsletter/settings/test構成テストを送信するnewsletter:writeEmailRecipientRequest
POST/newsletter/subscribers同意した購読者の追加または更新newsletter:writeNewsletterSubscriberRequest
DELETE/newsletter/subscribers/{subscriberId}サブスクライバーを削除しますnewsletter:write
POST/newsletter/campaignsキャンペーンの作成または更新newsletter:writeNewsletterCampaignRequest
DELETE/newsletter/campaigns/{campaignId}キャンペーンを削除するnewsletter:write
POST/newsletter/campaigns/{campaignId}/sendキャンペーンをキューに入れるかスケジュールするnewsletter:writeNewsletterSendRequest
DELETE/newsletter/campaigns/{campaignId}/send待機中のキャンペーンをキャンセルするnewsletter:write
07
チームと請求コラボレーターと招待を管理し、サブスクリプションを検査し、認証された Stripe チェックアウトまたはポータル セッションを開きます。
9 オペレーション
メソッドとパス操作必要なスコープ入力とコントロール
GET/teamメンバーと保留中の招待状のリストteam:read
POST/team/invitations電子メールを送信せずにワークスペースへの招待リンクを作成するteam:writeTeamInvitationRequest
PATCH/team/members/{memberUid}メンバーの役割を更新するteam:writeTeamRoleRequest
DELETE/team/members/{memberUid}ワークスペースメンバーを削除しますteam:write
DELETE/team/invitations/{invitationId}保留中の招待を取り消しますteam:write
GET/billingプランとサブスクリプション状態の読み取りbilling:read
POST/billing/checkoutStripe プランのチェックアウトを作成するbilling:writeBillingCheckoutRequest
POST/billing/portalStripe 請求ポータル セッションを作成するbilling:writeBillingPortalRequest
POST/billing/promotion-codeプロモーションコードを利用し、プランの利用権限を整合させるbilling:writePromotionCodeRedeemRequest
完全な OpenAPI 3.1 コントラクトを開く
認証

1 つのオートメーションと 1 つの環境に対して 1 つのトークンを作成します。

[ダッシュボード] > [アカウント] > [パーソナル API トークン] を開きます。トークンにその所有者と目的を識別する名前を付け、フル ワークスペース、読み取り専用ワークスペース、リンク専用、または個別のリソース スコープを選択し、有効期限を 30 日、90 日、または 365 日から選択します。文書化されたローテーション プロセスがすでに存在する場合は有効期限なしを選択します。

01

身元を確認してください

トークンの作成は機密性の高いアカウント操作であり、最新の Google 認証またはパスワード認証が必要です。

02

最小のスコープを選択してください

読み取りスコープと書き込みスコープはリソースごとに異なります。たとえば、 theme:read, theme:write, shop:read および shop:write. 書き込みスコープには、対応する読み取りスコープが自動的に含まれます。

03

シークレットを 1 回コピーします

OrbitPage は、回復可能なシークレットではなく、SHA-256 ハッシュを保存します。紛失した場合は、それを取り消して別のトークンを作成します。

04

コードの外に保存します

環境変数または CI シークレット ストアを使用します。トークンを URL、リポジトリ、スクリーンショット、ブラウザ バンドル、またはビルド ログに入れないでください。

macOS / Linuxbash
export ORBITPAGE_TOKEN='op_pat_...'

curl --silent --show-error --include \
  --header "Authorization: Bearer $ORBITPAGE_TOKEN" \
  https://orbitpage.com/api/v1/links
WindowsPowerShell
$env:ORBITPAGE_TOKEN = 'op_pat_...'
$headers = @{ Authorization = "Bearer $env:ORBITPAGE_TOKEN" }

Invoke-RestMethod -Uri 'https://orbitpage.com/api/v1/links' -Headers $headers
GET /links

コレクションを読み取り、変更する前にそのリビジョンをキャプチャします。

応答本文には、データ内の順序付けされたブロックと現在の数値リビジョンが含まれます。同じリビジョンが X-OrbitPage-Revision および弱い ETag として表示されます。いずれかの値を If-Match に保存します。無関係な実行にわたって推測したりキャッシュしたりしないでください。

応答例HTTP + JSON
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"
  }
}
data完全な順序付きブロック コレクション。配列の順序は、視覚的なページの順序です。
revisionすべての書き込みで使用されるオプティミスティック同時実行バージョン。
workspaceこのトークンに永続的にバインドされているテナント、ページ、およびユーザー名。
ETag次の If-Match ヘッダーとして直接渡す最も安全な値。
PATCH /links/{linkId}

既存のブロックに対する最小限の変更には PATCH を使用します。

GET によって返された ID を URL エンコードし、変更する必要があるフィールドのみを送信します。 OrbitPage はパッチを既存のブロックにマージし、ID フィールドと分析フィールドを保護し、完全なページをそのスキーマと計画に照らして検証し、すぐに公開します。

1 ブロックを更新curl
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
  }'
フィールドグループの例の動作
内容title, description, url, content, textItems既存のブロック タイプに対して有効な場合は編集可能です。
可視性とタイミングisActive, status, availability, startDate, endDate, timezoneスケジュールおよび計画ルールとともに検証されます。
出演とメディアicon, coverImage, backgroundColor, alignment, size値がページ スキーマと一致する場合にのみ受け入れられます。
保護されていますid, type, clickCount, ctaClicks, systemKey無視または拒否されました。システム管理のブロックにはパッチを適用できません。
PUT /links

PUT は、コレクション自体を変更する必要がある場合にのみ使用してください。

PUT は、完全な順序付きコレクションを置き換えます。ブロックを追加したり、ブロックを削除したり、ページの順序を変更したりする操作です。これは 1 つのタイトルを更新するためのショートカットではありません。ブロックを省略すると、そのタイトルがページから削除されます。

01GETすべてのブロックと ETag を読み取ります
02ローカルで変更するID と未タッチのブロックを保持する
03PUT + If-Match検証して公開する
安全な読み取り、変更、書き込みスクリプトNode.js 22+
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());
curl · n8n · OpenAPI

ネイティブ n8n ノード、または HTTP クライアント、生成されたクライアント、バックエンド、または CI ランナーからの同じコントラクトを使用します。

OrbitPage には SDK は必要ありません。JSON、ベアラー認証、および標準の GET、POST、PUT、PATCH、および DELETE リクエストを送信できる HTTPS クライアントは互換性があります。以下のパターンは、統合で明示的に処理する必要があるステートフルな部分をカバーしています。

01

ネイティブ n8n ノード

n8n-nodes-orbitpage をインストールし、個人トークンと Base URL を使って OrbitPage API の認証情報を作成します。接続テストはワークスペースを安全に読み取ります。その後、ガイド付き操作がパス、権限、項目の関連付け、リビジョンを考慮した書き込みを処理し、シークレットをワークフローの JSON に保存しません。

02

草案と出版

プロファイル、テーマ、ページ、サポートされている設定の書き込みには If-Match が必要で、デフォルトでドラフトが更新されます。適格な即時パブリケーションに ?publish=1 を追加するか、いくつかの延期された変更を確認し、POST /publication を 1 回呼び出します。 PATCH と PUT をリンクすると、すぐに公開されます。

03

メディアの直接アップロード

まず予約し、返されたストレージ URL にバイトをアップロードしてから、完了します。 OrbitPage ベアラー トークンを orbitpage.com にのみ送信します。ストレージ要求に対して返されたメソッドと一時ヘッダーのみを使用します。

04

AI コミットをレビューしました

Plan はページを変更せずに検証済みプレビューを返します。previewToken を保存して確認し、その提案だけを commit してください。自動化に公開権限がある場合に限り、commit 本文で publish を設定します。

ネイティブ n8n クイック スタートn8n
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)
3 ステップのメディアアップロードHTTP + JSON
# 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>" }
レビューファーストの AI フローHTTP + JSON
# 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 }
資格証明テスト

Base URL には /api/v1 を付けず、https://orbitpage.com を使用します。保存に成功すると /api/v1/workspace が読み取られ、データを変更せずにトークン、ワークスペースの関連付け、workspace:read 権限が確認されます。

n8n のトラブルシューティング

401 エラーには有効な代替トークン、403 エラーには不足している権限が必要です。リダイレクトが繰り返される場合は Base URL またはリバースプロキシを確認してください。サポートにはステータスと JSON コードだけを伝え、シークレットは共有しないでください。

完全なネイティブ n8n ノード ガイドを読む

オペレーション

自動化認証情報を短い観察可能なライフサイクルとして扱います。

ワークスペースは、ユーザーごとに最大 10 個のアクティブな個人トークンをサポートします。アカウント リストには、各トークンのプレフィックス、スコープ、作成日と有効期限、最近の使用状況が表示されます。最後に使用されたタイムスタンプは、最大 5 分に 1 回、意図的に書き込まれます。

GitHub ActionsYAML
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」)。
  • 代替トークンの作成、シークレット ストアの更新、1 つの読み取りのテスト、古いトークンの取り消しによってローテーションします。
  • 開示の疑いがある場合、所有権の変更、またはワークフローの廃止後は直ちに取り消してください。取り消しは次のリクエストで有効になります。
  • 有効期間の長い共有トークンを構築しないでください。個別の認証情報により、ログ、ローテーション、インシデント対応がわかりやすくなります。
障害の処理

HTTP ステータスと機械可読コードに関する分岐。

エラーでは、エラーとコードを含む JSON が使用されます。ワークフローを制御するために人間の文章を解析しないでください。ほとんどの 4xx 応答では、要求または資格情報の変更が必要です。リビジョンの競合とレート制限のみが自動再試行パスに属します。

400INVALID_JSON · LINKS_REQUIRED · LINK_PATCH_INVALIDページ スキーマによって拒否されたリクエスト本文またはフィールドを修正します。
401PERSONAL_TOKEN_*不足しているトークン、無効なトークン、期限切れのトークン、または取り消されたトークンを置き換えます。同じシークレットを使用して再試行しないでください。
403PERSONAL_TOKEN_SCOPE_DENIED · SYSTEM_LINK_PROTECTED必要なスコープを使用するか停止します。現在の ID ではこの操作を実行できません。
404LINK_NOT_FOUNDコレクションを更新します。ブロック ID が削除または置換された可能性があります。
409revision_conflict再度 GET し、意図した変更を新しい状態に再適用し、新しいリビジョンで再試行します。
413REQUEST_TOO_LARGEJSON 本文を 768 KiB 以下に保ちます。
415UNSUPPORTED_CONTENT_ENCODING非圧縮の JSON リクエスト本文を送信します。
428revision_required最新の GET によって返されたリビジョンまたは ETag を使用して If-Match を追加します。
429RATE_LIMITEDRetry-After を待ってから、指数バックオフとジッターを使用して再試行します。

現在のガードレールでは、トークンごとに 1 分あたり 120 リクエスト、1 日あたり 5,000 リクエストが可能です。不正行為からの保護中に制限が厳しくなる場合があります。常に Retry-After を尊重します。

セキュリティ

安全な統合は範囲が狭く、秘密であり、リビジョンを認識します。

01

最低権限

ジョブを公開する必要がない限り、読み取り専用を使用します。トークンの機能は、所有者の現在のワークスペースの役割を超えることはできません。

02

サーバー側のみ

信頼できるスクリプト、バックエンド、または CI ランナーから API を呼び出します。ブラウザ バンドル、モバイル クライアント、またはパブリック リポジトリはベアラー シークレットを保持できません。

03

ブラインド書き込みは禁止

書き込みの直前に GET を実行し、If-Match を使用してください。409 エラーで revision_conflict が返された場合は、リソースを再取得して意図した変更を適用し直してください。それ以外のコードでは、文書化された業務上の条件を解消してください。

04

結果を検証する

応答ステータス、リビジョン、返されたデータを確認します。重要な変更については、公開後に公開ページを開き、トークンをログに記録せずに失敗時に警告します。

エディション境界

個人トークンのオートメーション REST API は、マネージド SaaS 機能です。

オープンソース リポジトリには、バンドルされたダッシュボードで使用される Express API が含まれていますが、その内部管理セッション API は同じバージョン管理された自動化コントラクトではありません。 op_pat トークンをセルフホステッド サーバーに送信したり、セルフホステッド管理 JWT を orbitpage.com/api/v1 に送信したりしないでください。

管理されたワークスペース

このガイド、OpenAPI 契約、およびアカウントで作成された個人トークンを使用します。

セルフホスト型インスタンス

同じ信頼できるオリジンでバンドルされたダッシュボードを使用します。リポジトリのドキュメントでは、コントリビュータとメンテナの内部境界について説明しています。

オープンソース API 境界を読む
Automation REST API and personal tokens | OrbitPage