x-api-key 請求標頭中傳遞 API 密鑰來進行認證。
API 密鑰
啟潤支付使用 API 密鑰來認證請求。你可以在商戶控制台中管理你的 API 密鑰。 當前後端實作接受生產 API 密鑰:發送認證請求
在每個請求的x-api-key 請求標頭中包含你的 API 密鑰:
環境
目前公開生產 API 接受
kyren_live_ 前綴的生產密鑰。
商戶控制台目前不提供自助建立 kyren_test_ 測試密鑰。
只有在 Kyren 向你提供對應環境的 Base URL 和憑證時,才應使用 Staging 環境。重新產生 API 密鑰
如果你的 API 密鑰洩露,可以在控制台中重新產生:- 前往 控制台 > 開發者
- 點擊要替換的密鑰旁邊的重新產生
- 確認操作
錯誤回應
認證失敗時,API 返回401 Unauthorized 回應:
- 缺少
x-api-key請求標頭 - API 密鑰無效或已過期
- 使用了當前環境不接受的 API Key 前綴