/v1/products、/v1/checkouts 和 /v1/orders)透過 x-api-key 請求標頭中的 API 密鑰認證。
不同介面使用不同認證方式:
Epay 的獨立簽名規則見 Epay 簽名。
API 密鑰
啟潤支付使用 API 密鑰來認證請求。你可以在商戶控制台中管理你的 API 密鑰。 當前後端實作接受生產 API 密鑰:發送認證請求
呼叫需要認證的公開商戶整合介面時,在x-api-key 請求標頭中包含你的 API 密鑰:
環境
目前公開生產 API 接受
kyren_live_ 前綴的生產密鑰。
商戶控制台目前不提供自助建立 kyren_test_ 測試密鑰。
只有在 Kyren 向你提供對應環境的 Base URL 和憑證時,才應使用 Staging 環境。重新產生 API 密鑰
如果你的 API 密鑰洩露,可以在控制台中重新產生:- 前往 控制台 > 開發者
- 點擊要替換的密鑰旁邊的重新產生
- 確認操作
錯誤回應
需要認證的介面在缺少或拒絕 API 憑證時返回 HTTP401 Unauthorized。認證中介軟體不保證返回 JSON 回應本體,請先檢查 HTTP 狀態,再嘗試解析 JSON。應用層 JSON 錯誤碼見錯誤處理。
常見原因:
- 缺少
x-api-key請求標頭 - API 密鑰無效或已被重新產生
- 使用了當前環境不接受的 API Key 前綴
- 商戶帳戶被停用,或請求 IP 不在配置的 API IP 白名單內