管理驗證狀態

驗證是 API 測試與開發中的關鍵面向。妥善管理驗證狀態，可確保你的 API 請求安全、有效率，並且能準確反映真實世界的使用情境。

本指南示範如何在 Apidog 中有效處理驗證狀態，涵蓋常見的驗證方法與自動登入實作。

常見驗證方法

1. Session/Cookie 驗證

Apidog 會透過 session 與 cookie 自動維持驗證狀態。

運作方式：

執行登入 API 後，Apidog 會全域儲存回傳的 Session/Cookie 資訊

後續 API 呼叫會自動包含此 Session/Cookie 資訊

不需要針對每個請求手動設定

請參閱自動登入實作章節，了解如何透過 Session/Cookie 實現自動登入。

2. 以 Token 為基礎的驗證

以 Token 為基礎的驗證會將登入憑證包含在 API 請求參數中，通常位於 Header。常見方式包括 Basic Auth、Bearer Token 與 API Key。

實作選項：

選項 1：全域設定驗證

在不同層級設定驗證資訊：

專案層級：專案概覽頁面

群組層級：群組設定

個別 API 層級：文件頁面

支援的驗證類型：

Basic Auth

Bearer Token

API Key

OAuth 2.0

以及更多

選項 2：手動 Token 設定

手動將 token 加入 Header 或其他相關參數。我們建議使用環境變數來儲存 token。

範例：

Bearer Token：設定名為 Authorization 的 Header，其值為 Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6

使用環境變數：Bearer {{AUTH_TOKEN}}

選項 3：全域參數

在全域參數中設定值。所有 API 在執行時都會自動包含全域參數，無需針對每個 API 手動設定。

請參閱自動登入實作章節，了解如何透過 token 實現自動登入。

3. 自動登入方法

此方法會自動呼叫登入 API 以完成驗證，無需手動介入，並在各請求之間維持驗證狀態。

自動登入實作

期望結果

自動呼叫登入 API，無需手動介入

成功登入後保留驗證狀態，避免重複呼叫登入 API

憑證過期時重新整理 Token

實作步驟

步驟 1：設定環境變數

使用環境變數儲存驗證憑證：

ACCESS_TOKEN：儲存登入憑證

ACCESS_TOKEN_EXPIRES：儲存過期時間（如適用）

步驟 2：建立公開指令碼

此指令碼應：

檢查 ACCESS_TOKEN 是否有值，以及 ACCESS_TOKEN_EXPIRES 是否仍然有效

若有效，繼續執行請求

若無效或不存在，繼續下一步

使用 pm.sendRequest 呼叫登入 API

將回傳的憑證與過期時間寫入環境變數

步驟 3：設定需要驗證的 API

針對每個需要驗證的 API：

將驗證參數設定為 {{ACCESS_TOKEN}}

將 Authorization header 設定為 {{ACCESS_TOKEN}}

或視需要使用 cookies／其他參數

或者，在全域參數中設定該值，以便所有 API 呼叫自動包含

在前置處理器指令碼中引用公開指令碼

公開指令碼範例

重要注意事項：

此指令碼中的登入憑證來自 LOGIN_USERNAME 與 LOGIN_PASSWORD 環境變數。使用此程式碼前，請確保這些變數已設定。

如果你的 token 不會過期，請移除與 ACCESS_TOKEN_EXPIRES 相關的程式碼。

請依照你的特定 API 需求調整登入請求結構與回應處理方式。

其他資源

pm.sendRequest documentation

pm.cookies documentation

常見驗證方法#

1. Session/Cookie 驗證#

2. 以 Token 為基礎的驗證#

選項 1：全域設定驗證#

選項 2：手動 Token 設定#

選項 3：全域參數#

3. 自動登入方法#

自動登入實作#

期望結果#

實作步驟#

公開指令碼範例#

其他資源#

常見驗證方法

1. Session/Cookie 驗證

2. 以 Token 為基礎的驗證

選項 1：全域設定驗證

選項 2：手動 Token 設定

選項 3：全域參數

3. 自動登入方法

自動登入實作

期望結果

實作步驟

公開指令碼範例

其他資源