Skip to main content
除 GET /openapi.json 外，所有端點都需要有效的 API 金鑰。金鑰的範圍限定於機構（organization-scoped）—— 金鑰只能存取核發它的機構所屬的資料，並以機構身份而非個別教練身份操作。

​
建立金鑰

API 金鑰由主教練或機構管理員在 Coach Console 的 Settings → Security 下管理。
1

開啟 Settings → Security

在網頁主控台中，前往 Settings → Security 並找到 API keys 區塊。
2

命名金鑰並選擇存取範圍

為金鑰指定一個描述性名稱（例如「Analytics dashboard」），並選擇你的整合所需的 存取範圍（Scopes）。預設為唯讀。
3

設定到期日

選擇到期時間窗口——預設為 90 天。允許永不到期的金鑰，但不建議使用。
4

只有一次機會複製密鑰

完整金鑰（nrx_prod_…）僅在建立時顯示一次。請立即複製至你的密鑰儲存庫—— 日後無法再次查看。
請像對待密碼一樣保管 API 金鑰。將其儲存在密鑰管理工具中，切勿放入版本控制或用戶端程式碼。 若金鑰外洩，請在 Settings → Security 撤銷該金鑰並重新核發一組新金鑰。

​
傳送金鑰

支援兩種方式。建議使用 Bearer。

​
到期與撤銷

  • 到期在每次請求時強制執行。使用已到期金鑰的請求會收到 401 及代碼 key_expired—— 你的整合可藉此偵測原因，提示取得新金鑰，而非靜默失敗。
  • 撤銷立即生效。被撤銷的金鑰會收到 401 及代碼 key_revoked。
  • 未知或格式錯誤的金鑰會收到 401 及代碼 invalid_key。
完整的錯誤信封與代碼列表請見錯誤。

​
金鑰輪替

系統不提供自動輪替。手動輪替步驟：建立新金鑰，部署後確認流量已切換 （主控台會顯示每個金鑰的最後使用時間），再撤銷舊金鑰。