# 取得API Key

操作路徑

登入【商戶後台】-> 進入【開發者中心】-> 點選【API Key】選單 -> 編輯 -> 點選【建立】

# 配置說明

  • 每個 API Key 都配有獨立配置頁，可綁定 固定 IP 位址。
  • 若將 IP 設定為 0.0.0.0，表示不做 IP 限制，任何來源 IP 都可存取介面。
  • 建議為不同業務場景/系統建立 不同的 API Key，以實現權限隔離與管理彈性。

# 注意事項

  • Access Key 和 Secret Key 是您的身份憑證，請妥善保管，不要洩露給第三方。
  • Secret Key 僅在建立時展示一次，請務必當場儲存好。
  • 若您遺忘 Secret Key，請登入後台回收目前金鑰對，並重新申請新的 API Key。

# 建立 API Key

  1. 選擇是否開啟除錯模式

    • 開啟後，如介面呼叫失敗，系統將提供標準化的錯誤提示及日誌位址，方便問題排查。
    • 提示：為保障生產環境安全，測試完成後請及時關閉除錯模式，防止敏感資訊洩露。

  2. 選擇 API Key 權限範圍

  • 根據業務需求選擇相應權限（如：唯讀、交易、回呼權限等）。
  1. 輸入白名單位址
  • 可填寫允許存取該 API Key 的 IP 或網域名稱白名單。
    • 支援多個位址，用英文逗號 , 分隔。 範例：192.168.1.1,10.0.0.1,www.example.com
  • 若填入 0.0.0.0，表示不限制 IP，任意來源可存取（不推薦用於生產環境）。
  1. 點選建立 API Key
    • 建立成功後，系統將產生一組 Access Key 和 Secret Key。
    • ⚠️ 注意：Secret Key 僅在產生時展示一次，請務必妥善儲存。 若遺忘 Secret Key，請透過後台【回收】該金鑰對並重新申請新的 Key。

img

# 編輯 API Key

  • 點選 編輯按鈕 可對以下內容進行調整：
    • 開啟 / 關閉 【除錯模式】
    • 修改 API Key 權限
    • 更新 白名單位址
  • 修改完成後，點選 儲存 即可套用變更。

請注意：API Key 建立或編輯後約需 90 秒生效。 在此期間呼叫介面可能仍使用舊配置，請耐心等待再進行請求驗證。

img

# 使用APIKey

當前 API Key 需在請求的 Header 中加入以下參數：

參數名 參數說明 類型 是否必填
access_key API Key 存取金鑰（如：TPhoa7ZQ） String 是
timestamp 毫秒級時間戳（13 位，如：1679669488472） String 是
nonce UUID（36 位，如：02f7a04f-53cc-47d4-bb3f-fae69dab49ac） 五部分組成：8-4-4-4-12 位，用 - 分隔 String 是
sign 簽名字串（如：GXx2wYUD6UVr+zcmeCSFFPzcBLA=） String 是

← 資料簽章規範 →