內容

目的

需求

介紹

設定

驗證

結論

目的

這篇文章提供關於如何根據 OpenAPI 文件呼叫 NVR API 介面的指南。它可以作為將 NVR 與第三方軟體平台整合的參考。

需求

• VIGI NVR (韌體需要支援 openAPI)
• VIGI NVR Open API 文件
• 筆記型電腦和 Postman

介紹

基於 NVR OpenAPI 功能和 OpenAPI 文件，VIGI NVR 可以整合到第三方軟體平台。本文件使用 Postman 軟體作為範例來演示如何呼叫 NVR API 介面。

設定

完成摘要認證並取得 access_token

步驟 1. 使用 NVR 的 IP 位址登入其網頁介面。輸入 使用者名稱 和 密碼，點擊 登入。

步驟 2. 導覽至 設定 > 網路 > Openapi。啟用 OpenAPI 功能。

注意：預設的 OpenAPI 埠為 20443。如果您修改了埠或為遠端存取設定了埠轉發，請確保您請求中的 OpenAPI 埠已更新以匹配實際使用的 OpenAPI 埠。

步驟3. 開啟Postman。參考文件，選擇GET 方法並輸入：https://192.168.68.100:20443/openapi/token。發送一個 No Auth 請求 以從 回應標頭 中取得 nonce 和 其他參數。

步驟 4. 參考文件，計算 請求標頭 中的 回應 以進行 摘要認證。該 回應 是由 NVR 回傳的 使用者名稱、密碼和認證資訊 衍生而來的。如果 NVR 指定 SHA-256 作為演算法，則計算方式如下：

• A1 = SHA256(admin:realm:password)
• A2 = SHA256(method:uri)
• response = SHA256(A1:nonce:A2)

使用從前一步驟的回應標頭中取得的資訊以及上述計算方法來產生回應。

步驟 5. 參考 OpenAPI 文件。在請求標頭中，新增 Authorization，輸入值，即 Digest username="admin", nonce="", realm="TP-LINK NVR", response=" "。點擊 傳送。

您將取得 access_token。

呼叫 API 介面

步驟 1. access_token 已由百分比編碼（Percent-encoding）作為 URL 編碼，請記得解碼，因為標頭欄位需要原始字串。您可以使用線上工具進行解碼，例如：https://url-decode.com/。

步驟 2. 在 Authorization 中，選擇 Bearer Token，輸入 解碼後的 access_token。參考文件。選擇 API 方法 並輸入 請求和請求本文（某些 API 方法需要本文）。

此文件提供了呼叫某些特定 API 的詳細說明，具體取決於是否包含請求本文。

• added_devices。此 API 用於取得已新增的設備。

參考 OpenAPI 文件。選擇 GET 方法，輸入 請求，點擊傳送。回應本文將包含已新增設備的資訊。

• sound。此 API 用於設定輸出聲音。

參考 OpenAPI 文件。選擇 POST 方法，輸入 請求。在 請求本文 中，選擇 raw 和 JSON 格式。輸入 本文，關閉頻道 1 攝影機的靜音功能，將攝影機音量設定為 43，系統音量設定為 76，然後點擊 傳送。

驗證

步驟 1. 導覽至 資訊 > 系統訊息 > 頻道資訊。檢查已新增攝影機的資訊。比較回傳的 回應本文 中的設備資訊以驗證一致性。

步驟 2. 導覽至 設定 > 攝影機 > 串流 > 音訊。檢查頻道 1 攝影機的靜音功能是否已 停用，攝影機音量 設定為 43，且 系統音量 設定為 76。

結論

您已成功呼叫 added_devices API 以檢索 NVR 頻道下的設備資訊，並成功呼叫 sound API 以修改 NVR 頻道的攝影機音量設定。

若要了解更多各項功能與設定的詳情，請前往 下載中心 | TP-Link 下載您產品的手冊。