使用瀏覽打開主題

BarTender REST API 提供 REST 端點，您可以使用這些端點透過 YAML 或 JSON 檔案格式或現有的舊版 BTXML 指令碼在非 Windows 平台上或跨網路實現系統自動化。透過使用 BarTender REST API，您可以使用大部分類型的程式設計語言，包括 C#、Java、Perl 或 Python，以及大部分整合式開發環境 (IDE) 來建立您的自動化指令碼。

支援的技術

BarTender REST API 使用與 Integration Builder 和 Process Builder 相同的 BarTender Integration Service 和 Print Scheduler 服務。與伺服器的通訊會透過連接埠 5159 進行。

對於傳送指令碼和接收回應，API 支援 JSON、YAML 和 BTXML 格式的資料裝載。A YAML reference document is included in the BarTender installation; for more information, refer to Available Actions in the Actions API.如需有關 BTXML 的更多資訊，請參閱「使用 BTXML 指令碼」。

API 支援下列技術：

• 跨原始來源資源共用 (CORS)，以便可以從源自任何地方的網站存取 REST 端點

• 多種驗證方法，包括基本驗證、整合式驗證 (Microsoft Negotiate) 和 Windows 挑戰/回應 (NTLM)

  出於安全目的，依預設會停用基本驗證。若要啟用基本驗證，可以在 appsettings.json 組態檔中將其設定變更為 "true"。此檔案安裝在下列目錄中： C:\Program Files\Seagull\BarTender 2022\net6.0

• 安全 HTTPS

需求

若要使用 BarTender REST API，需要滿足下列條件：

• 您執行的是自動化版或企業版的 BarTender 2022。

• 連接埠 5159 已開啟，以便 API 可以接收 REST 指令。

• 您有權登入伺服器，並且擁有在 Administration Console 中設定的「管理整合」權限。

在本節中

• 存取 API 以檢視端點說明文件和執行測試

  說明可用於存取 BarTender REST API 和測試自動化指令碼的應用程式。

• Actions API

  說明可用於建立指令碼並提供程式碼範例的 BarTender REST API 指令。