使用瀏覽打開主題

BarTender 為API端點提供完整的說明文件，並搭配YAML、JSON及BTXML格式的動作範例。BarTender安裝完成後可使用ReDoc檢視此文件，其包含在BarTender安裝檔中。

使用 ReDoc 檢視 API

在您設計自己的應用程式以使用 API 之前，您可能希望使用工具來測試如何使用 API。您可以使用多種熱門工具之一 (例如，Insomnia 和 Postman) 來存取 API 端點。

使用 Insomnia 存取 API 端點

遠端連線注意事項

如果您在使用遠端連線的電腦上執行 BarTender，請在存取 REST API 以執行 API 和擷取 API 說明文件時考量下列指導方針：

• 必須設定 Microsoft Internet Information Services (IIS)，並在執行 BarTender REST API 的伺服器上安裝 Print Portal。

• 若要存取 API 端點，請使用 "http://<主機名稱或 IP 位址>/BarTender/api/actions"。

• 若要存取 ReDoc 說明文件，請使用 "http://<主機名稱或 IP 位址>/BarTender/api/actions/reference/index.html"。

• 瀏覽器可能會提示您輸入認證以進行驗證。

• 如果您是網域使用者，並且您正在執行的遠端電腦位於相同的 Windows 網域中，則可以使用您的網域帳戶登入。否則，需要該遠端電腦的本機帳戶。

疑難排解

執行 REST API 時，可能會出現下列錯誤：

• 401：表示 HTTP 用戶端無法登入 URL 中指定的電腦。

• 403：表示登入要求來自沒有管理整合權限的使用者。若要使用 API 執行動作或 BTXML 指令碼，必須在 Administration Console 中將使用者的「管理整合」權限指定為「允許」。