簡介

在 BarTender 2021 及之後版本，開發人員現在可以透過完整的 REST API 集合與 Print Portal 互動。您可以透過我們的 REST API 執行大多數操作，例如驗證使用者、列出現有的資料夾、標籤和印表機，以及列印標籤，只需發送查詢並以 JSON 取得結果即可。

本文旨在簡要介紹 Print Portal REST API，將帶您了解 REST API 的驗證方式，並示範如何使用 swagger 工具進行 API 測試。

端點與方法

Print Portal REST API 採用 RESTful 原則設計，因此支援兩種最常用的 HTTP 方法：GET 和 POST。 

Print Portal REST API 透過端點 URI 提供資源存取。所有 Print Portal API 端點的 基礎 URL 如下：

{Print Portal Base URL}/BarTender 

提交 REST API 請求時，必須使用特定的端點。Print Portal API V1 包含4 個端點，分組如下：

表 1-1 Print Portal REST API 端點與方法。

/api/v1/Authenticate

/api/v1/print

/api/v1/libraries/{id}

/api/v1/printers/{printerName}

驗證方式

當啟用驗證時，必須由已驗證的使用者發出請求，才能存取 Print Portal 資源。驗證成功後，系統會回傳一組 token。

要產生驗證 token，請發送一個 POST 請求到

{Print Portal Base URL}/BarTender/api/v1/Authenticate

並帶入以下內容：

{
 "userName": "UserName@Domain",
 "password": "Password"
}

這會回傳一個包含 token 屬性的 JSON 使用者結構：

{
 "success": true,
 "token": "string",
 "expires_in": 0
}

在呼叫 REST API 端點時，所有後續請求都需要在標頭加上 Authorization，格式如下：

Authorization: Bearer <TokenString>

開始使用 Swagger UI

Print Portal 也內建一套稱為 swagger 的 REST API 規格系統。Swagger UI 讓您可以在不需要實作邏輯的情況下，直接瀏覽並互動 API 資源。可以把 swagger 想像成 REST API 的說明系統，提供說明、測試請求的執行環境，以及每個功能的詳細解釋。

您可以在 Print Portal Base URL 的 BarTender 後面加上 swagger 來存取 swagger，例如：

{Print Portal Base URL}/BarTender/swagger/

swagger 介面分為上下兩部分，這點很重要，有助於您找到正確的資訊。上半部包含API 功能說明，並可直接測試 API 請求。下半部標題為「Models」，提供每個功能及其需求的說明。

如前所述，Swagger UI 提供了許多省時功能，讓您在部署時測試 API 變得簡單又方便。例如，若要測試驗證功能，展開最上方的項目即可查看驗證需求。

點選「Try it out」按鈕，然後以以下格式輸入您的帳號與密碼：

接著點選藍色的 Execute 按鈕：

如果 PrintPortal 驗證已啟用，且帳號密碼正確，系統就會回傳成功訊息，以及日後呼叫 REST API 所需的 驗證 token。

更多資訊

如需更多協助自動化 Print Portal 的相關資訊，您可以參考 Print
Portal 說明系統。