Partner App 設定 (DOC-APP-001)
Partner App 是你的整合在 KNOW 平台上的登記單位,用來持有憑證、OAuth 設定與存取權限。
基本欄位 (DOC-APP-002)
| 欄位 | 用途 | 限制 |
|---|---|---|
| Handle | API 路徑中使用的唯一識別碼,也顯示於 Dashboard | 3–40 個字元;只能使用英文小寫字母、數字、_ 和 -。建立後不可修改。 |
| Display Name | OAuth 授權頁面上顯示給使用者的名稱 | 必填;1–80 個字元。 |
| Description | 應用程式的簡短說明 | 選填;最多 500 個字元。 |
| Website URL | 你的整合服務的首頁或行銷網站 | 選填;必須為有效的絕對 URL。 |
| Code of Conduct URL | 社群規範或使用政策連結 | 選填;必須為有效的絕對 URL。 |
Handle 在建立時設定後即無法更改。請謹慎選擇,因為它會出現在 API 路徑中,並對你的使用者可見。
App 所有權 (DOC-APP-003)
建立 Partner App 時,你需要選擇以下其中一種所有權模式:
- 由我個人擁有 — App 歸屬於你的個人 KNOW 帳號,只有你能在 Dashboard 管理它。
- 由團隊擁有 — App 歸屬於你擔任 OWNER 或 ADMIN 的團隊。該團隊中所有 OWNER 與 ADMIN 成員均可管理此 App。
所有權建立後無法轉移。若你需要多人共同管理,請從一開始就選擇團隊所有權。
重新導向 URI (DOC-APP-004)
重新導向 URI 告訴 KNOW 授權伺服器在使用者同意(或拒絕)後,要將使用者重新導向到哪個網址。
授權時強制執行的規則:
- 必須為絕對 URL(例如
https://example.com/callback)。 - 在 OAuth 設定頁中每行填入一個 URI。
- 授權請求中的
redirect_uri參數必須與已登記的其中一個 URI 完全相符,不支援前綴或萬用字元比對。 - 正式環境必須使用 HTTPS。 開發階段可接受
http://localhost。
Client 密鑰 (DOC-APP-005)
Client 密鑰在你首次為 App 啟用 OAuth 時產生,之後每次點擊重新產生也會產生新的密鑰。
- 完整的密鑰值只會顯示一次,即產生後立即顯示。請在離開頁面前複製;之後無法再次查看。
- 重新產生密鑰會撤銷所有現有的 OAuth 存取令牌。 先前已授權的使用者需要重新授權。
- 請將密鑰儲存在環境變數或專用的 Secret Manager(例如 AWS Secrets Manager、Doppler)中。絕對不要將密鑰嵌入前端程式碼、行動裝置二進位檔或版本控制中。
隱私政策 (DOC-APP-006)
啟用 App 的 OAuth 功能之前,必須先填寫隱私政策網址(Privacy Policy URL)。
若你的 App 尚未設定隱私政策網址,OAuth 設定頁面會顯示提示訊息,且啟用 OAuth 按鈕將不可用。請先到 App 的編輯頁面填入網址,再回到 OAuth 設定頁面啟用。