API資源交易配置說明

API資源交易配置說明

中央授權中心客戶端API資源設定與授權操作指引

版本/日期:v1.1 / 2025-05-30
製作單位:中央授權中心 開發維運團隊


說明目的與背景

  • 說明如何使用中央授權中心平臺完成 API 使用權限申請與授權
  • 界定 API 提供方與 API 使用方各自角色與操作責任
  • 建立統一的 API Scope 授權管理流程,強化安全性與可追蹤性

【TIPS】
1、API Scope 主要用於 OAuth2 Bearer Token 授權場景中,決定 Access Token 的可存取資源範圍。
2、API Scope 用來細分 API 的功能權限,讓授權行為具備可控性、最小授權原則。
3、管控 API Scope 發放 Access Token 是中央授權中心除單點登錄(SSO)之外另一大功能。


API 授權整體說明

  • 中央授權中心 只會記錄“實際授權”行為,由 API 提供方執行操作
  • 使用方不能直接發 API 授權申請,僅能透過郵件/相信APP等IM或公司簽核系統表單表達需求
  • Scope 範圍由 API 提供方自行選擇與授權

【接下展開說明】

  • API 提供方設定方式
  • API 使用方申請流程
  • API 提供方授權流程

API 提供方設定方式

  • 1、在「開發中心」「我的客戶端」選擇修改對應的客戶端,進入「API資源」頁籤。
  • 2、點選【新增 API 資源】,填写詳細資料:
  • 資源名稱:必須以 ClientId. 為開頭
  • 設定 Scope:也必須以資源為前置
  • 3、Scope 設計應依據實際業務需求,決定資料存取的管控顆粒度。

API 使用方申請流程

  • 1、進入對應的 Client 修改界面切換至「API資源」頁籤,并點擊點選【API客戶端間授權】按鈕。
  • 2、複製ClientId、請求TOKEN、請求有效期資料
  • 3、透過郵件/相信APP等IM聯絡對應 API 提供方,表達請求。

API 提供方授權流程

  • 1、發收申請後,登入中央授權中心
  • 2、前往【API 客戶端間授權】,點選【授權給其他客戶端 API Scope】
  • 3、輸入申請方「請求TOKEN」,選擇要授權的 Scope
  • 4、確認授權,直接生效
  • 5、后續管理過程中,可以修改授權內容

  • ✅ 請注意:你只能授權自己定義的 API Scope