處理 API 簽章

API 簽章是用於驗證請求真實性與完整性的安全機制。本指南示範如何在 Apidog 中自動產生簽章，省去為每個請求手動取得簽章的需求。

簽章自動化策略

與其在每次請求前手動存取簽章端點，不如使用 Apidog 的腳本功能來：

建立實作簽章邏輯的公開腳本

使用請求參數自動產生簽章

透過腳本或環境變數將簽章附加到請求

在 API 前置處理器中引用公開腳本

實作方式

方法 1：直接修改腳本

透過腳本直接新增簽章參數並修改請求資訊，不使用環境變數。

優點：

不需要管理環境變數

立即更新參數

設定更簡單

方法 2：環境變數

產生簽章並將其寫入環境變數，然後在 API 參數中引用該變數。

優點：

可在多個請求間重複使用

更容易除錯與監控

集中管理簽章

方法 3：外部程式

若簽章是以其他語言實作，請使用 dog.execute 方法呼叫外部程式。

範例：基於 MD5 的簽章

簽章產生規則

步驟 1：建立參數字串

收集所有非空參數到集合 M

依 ASCII 碼由小到大排序參數（字典序）

以 URL 鍵值格式串接參數：key1=value1&key2=value2...

結果：stringA

重要規則：

參數名稱依 ASCII 碼由小到大排序

空參數值會從簽章中排除

參數名稱區分大小寫

sign 參數本身會從簽章中排除

步驟 2：產生簽章

將 key 串接到 stringA 的末尾，得到 stringSignTemp

對 stringSignTemp 套用 MD5 演算法

將結果轉為大寫，得到 signValue

公開腳本實作

範例：翻譯 API 簽章

簽章產生規則

步驟 1：串接字串

依序串接以下值：

appid：應用程式 ID

q：要翻譯的文字（UTF-8 編碼）

salt：隨機數

key：平台指派的金鑰（可在管理主控台取得）

結果：appid + q + salt + key

步驟 2：產生簽章

對串接後的字串套用 MD5 演算法，取得 32 位元小寫簽章。

重要注意事項：

要翻譯的文字（q）必須使用 UTF-8 編碼

串接 appid+q+salt+key 時，不要對 q 套用 URL 編碼

簽章產生後，在傳送 HTTP 請求前再對 q 套用 URL 編碼

範例請求

公開腳本實作

最佳實務

實務	說明
使用環境變數	將敏感金鑰儲存在環境變數中，而不是腳本中
驗證參數	在產生簽章前檢查必要參數
記錄以便除錯	使用 `console.log()` 來除錯簽章產生問題
處理邊界情況	考量空值、特殊字元與編碼
集中化邏輯	使用公開腳本以避免重複簽章邏輯
徹底測試	使用已知測試案例驗證簽章產生

簽章自動化策略#

實作方式#

方法 1：直接修改腳本#

方法 2：環境變數#

方法 3：外部程式#

範例：基於 MD5 的簽章#

簽章產生規則#

公開腳本實作#

範例：翻譯 API 簽章#

簽章產生規則#

範例請求#

公開腳本實作#

最佳實務#

簽章自動化策略

實作方式

方法 1：直接修改腳本

方法 2：環境變數

方法 3：外部程式

範例：基於 MD5 的簽章

簽章產生規則

公開腳本實作

範例：翻譯 API 簽章

簽章產生規則

範例請求

公開腳本實作

最佳實務