概覽

教程按"我想做什麼"組織,與按資源組織的 API 參考 互補。每篇 教程都以一個明確的開發者目標開頭(例如"讓我的 SaaS 用戶用 AppForges 賬號 登錄"),逐步走到可運行的代碼。

主題分類

  • 鑑權 — User / Org 身份與 OAuth / API Key 憑證的選型
  • Webhook — 註冊訂閱、原始 body 簽名校驗與協議邊界
  • 錯誤處理與重試 — 統一錯誤模型、何時該重試、X-Idempotency-Key 用法
  • 版本與升級 — /v1/ + X-AppForges-Api-Version 請求頭與生效版本

推薦閱讀路徑

第一次接入:

  1. 快速開始 — 5 分鐘跑通第一個 API 調用
  2. 選擇鑑權方式 — 選定身份類型
  3. 錯誤處理與重試 — 寫得穩的客戶端
  4. 版本與升級 — 升級不踩坑

所有教學

OAuth 總覽
/guides/authentication/oauth/overview
創建應用與 OAuth client
/guides/console/creating-oauth-app
用戶與組織身份
/guides/identities/user-vs-org
申請權限
/guides/authorization/requesting-scopes
鑑權總覽
/guides/authentication/overview
API Key 管理
/guides/console/api-key-management
Authorization Code + PKCE
/guides/authentication/oauth/authorization-code
權限目錄
/guides/authorization/scopes-catalog
身份兼容性
/guides/identities/identity-compatibility
選擇鑑權方式
/guides/authentication/choose-your-auth
錯誤處理與重試
/guides/errors-and-retries
Client Credentials
/guides/authentication/oauth/client-credentials
OAuth client secret 輪換
/guides/console/client-secret-rotation
Token 與身份
/guides/identities/token-claims
快速開始:用戶 OAuth
/guides/authentication/oauth-quickstart-server-side
敏感權限
/guides/authorization/sensitive-scopes
版本與升級
/guides/versioning-and-upgrades
小文件上傳編碼
/guides/uploads
API Key 鑑權
/guides/authentication/api-key
Refresh Token
/guides/authentication/oauth/refresh-token
Webhooks
/guides/webhooks
用戶授權頁面
/guides/authorization/consent-screen
管理 redirect URI
/guides/console/managing-redirect-uris
Token Introspection
/guides/authentication/oauth/token-introspection
Webhook 管理
/guides/console/webhook-management
Webhook 簽名驗證
/guides/authentication/webhooks-signing
Token 撤銷
/guides/authentication/oauth/token-revocation
應用成員管理
/guides/console/managing-organization-members