配置Postman以在vManage上執行API

簡介

本文檔介紹如何使用Postman執行應用程式程式設計介面(API)。

系統要求

• 已安裝Postman
• 訪問vManage以及使用者名稱和密碼憑證

注意：如果您沒有Postman，請從https://www.postman.com/downloads/下載它

背景資訊

主要或最常用的HTTP動詞（或方法，它們被正確稱為）是POST、GET、PUT、PATCH和DELETE。

它們分別對應於建立、讀取、更新和刪除（或CRUD）操作。

也有一些其他的動詞，但使用頻率較低。在這些頻率較低的方法中，OPTIONS和HEAD的使用率高於其他方法。

配置Postman以執行API

步驟1.開啟Postman並建立新的HTTP請求。

如果按一下任何突出顯示的選項，則可以建立新的HTTP請求。

建立新的HTTP請求。

步驟2.使用您的使用者名稱和密碼憑證進行身份驗證，以進行vManage。

建立另一個HTTP請求。

1. 選擇POST作為HTTP謂詞。
2. 在POST旁邊新增https://<vmanage-ip>/j_security_checknext。
3. 按一下「Body」，然後分別將j_username和j_password引數及其值新增為KEY引數。
4. 按一下「Send」。

注意：在此示例中，vManage ip address（vManage ip地址）為10.88.244.30，埠為5301

注意：用於使用者名稱和密碼值，我們使用admin。

在Postman中填寫引數。

vManage authentication。

注意：此API呼叫的響應必須為空

步驟3.請求權杖

1. 選擇GET作為HTTP謂詞。
2. 在GET https://<vmanage-ip>/dataservice/client/token旁邊新增API呼叫詳細資訊
3. 按一下「Send」

註：自vManage 19.2.1版起，成功登入的使用者必須通過API呼叫為每個POST/PUT/DELETE操作傳送X-XSRG-TOKEN或CSRF令牌。

執行API呼叫後，將在正文中獲取響應字串。儲存該字串。圖中所示為Postman輸出示例。

為vManage請求令牌

警告：如果您沒有獲得如圖所示的令牌，請重複此步驟。

步驟4.繼續執行另一個API以進行vManage。

此範例包含一個POST請求

1. 選擇要執行的API呼叫，在我們的情況下為https:///dataservice/statistics/dpi/aggregation

提示：如果您希望探索其他API呼叫，請轉到vManage url https://vmanage-ip:port/apidocs

2.收集您的API呼叫正文。

注意：此API呼叫包含JSON格式的正文

3.按一下Header，然後將字串X-XSRF-TOKEN新增為Key作為值。

4.按一下「傳送」。

顯示的影象顯示了必須如何顯示API呼叫。

DPI聚合API呼叫。

步驟5.關閉您的會話

從vManage和/或裝置檢索到所需的所有資訊後，即可釋放vManage的資源，消除惡意使用者使用您的會話的可能性。

在自動化環境中運行API呼叫

儲存Cookie和要在後續API呼叫中使用的變數

如何在變數中儲存令牌？

將令牌儲存在變數中，以便以後重複使用。

將令牌儲存在變數中

當我們以JSON格式請求令牌時，請將其儲存。使用測試頁籤並貼上顯示的行。

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("token", jsonData.token);

pm.test("Status code is 200", () => {
 pm.expect(pm.response.code).to.eql(200);
});