Skip to main content

API 金鑰驗證

Skiesoft「聽有 AI」使用 API 金鑰進行身份驗證。每個請求都必須在標頭中包含有效的 API 金鑰。

取得 API 金鑰

  1. 前往 軟雲開發者控制台
  2. 登入您的帳號或建立新帳號
  3. 建立新的 API 金鑰
  4. 記錄您的 API_KEY
請妥善保管您的 API 金鑰,不要在公開的程式碼庫中暴露金鑰資訊。

驗證方式

所有 API 請求都必須在 HTTP 標頭中包含以下資訊:

環境變數設定

建議使用環境變數來儲存敏感資訊:

測試驗證

使用以下程式碼測試您的 API 金鑰是否正確設定:

安全最佳實踐

1. 金鑰管理

  • 不要硬編碼:永遠不要在程式碼中硬編碼 API 金鑰
  • 使用環境變數:將金鑰儲存在環境變數或安全的配置檔案中
  • 定期輪換:定期更新您的 API 金鑰
  • 最小權限原則:只授予必要的權限給 API 金鑰

2. 網路安全

  • 使用 HTTPS:所有 API 請求都必須使用 HTTPS
  • IP 白名單:在控制台中設定 IP 白名單限制存取
  • 請求簽名:對於高安全性需求,可啟用請求簽名驗證

3. 錯誤處理

正確處理驗證錯誤:

開發與正式環境

測試環境

用於開發和測試的環境:

正式環境

用於生產環境的設定:

配額與限制

每個 API 金鑰都有使用配額和頻率限制:

監控使用量

常見問題

Q: API 金鑰格式是什麼?

A: 測試環境金鑰以 sk_test_ 開頭,正式環境金鑰以 sk_live_ 開頭,後面跟著 32 位英數字元。

Q: 如何重新產生 API 金鑰?

A: 在開發者控制台的專案設定中,點擊「重新產生金鑰」按鈕。舊金鑰將立即失效。

Q: 可以同時使用多個 API 金鑰嗎?

A: 可以,每個專案可以產生多個 API 金鑰,方便不同環境或應用程式使用。
需要協助設定身份驗證?請聯絡我們的技術支援:support@skiesoft.com