API Key 鑑權

API Key 鑑權

創建與調用

打開應用列表,選擇應用,在Credentials的API Keys區域創建key並填寫允許scope。創建時一次展示的明文放入安全後端配置,不進入Git、日誌或客戶端代碼。

規範API Key頭是 X-API-Key,不要把key當成用戶OAuth token。只有端點允許API Key、主體滿足身份要求且scope足夠時才能調用。示例只說明傳遞方式,請選擇你有權限的實際端點:

curl --fail-with-body "${APPFORGES_API_BASE_URL}/v1/users/me" \
  -H "X-API-Key: ${APPFORGES_API_KEY}" \
  -H "X-AppForges-Api-Version: 2026-04-01"

該profile端點要求用戶身份及 user:profile:read,組織/服務key不能憑空提供用戶身份。用戶首次接入建議使用OAuth流程。

有效期、scope和主體以key實際配置為準,不宣稱key永不過期。輪換、撤銷見API Key管理。