問題

有哪些 API 可供使用？每個 API 有哪些功能？

適用於 

• BarTender Cloud REST API
• Automation 訂閱

Security API

Security API 可管理所有使用者、權限、群組和角色。

安全性基本概念

安全性在 Cloud 中的作業方式與在內部部署 BarTender 中略有不同。最大的關鍵不同在於沒有拒絕權限的概念。

內部部署 BarTender 具有拒絕的概念，只要指定拒絕權限 (無論是在群組上設定，還是在使用者本身上明確設定)，便會覆寫特定使用者的任何允許權限。這會將使用者的有效權限設定為「永遠拒絕」，而無論是否在其他地方設定為允許。

Cloud 沒有如此明確的設定，而是在允許或不允許的權限系統上作業。它會建立所有來源 (角色、群組、個別設定) 的聯集，以確定是否允許使用者執行動作。如果使用者在某一個群組中可以執行某項動作，即使該使用者在另一個群組中沒有相應的允許權限設定，也可以執行該項動作。 例如，如果使用者 A 屬於文件管理群組 (可以管理文件)，但又屬於列印操作員群組 (僅具有列印權限)，則使用者 A 具有管理文件的權限，因為其中一個群組具有此權限。

使用者管理

該 API 可以執行下列作業：

• 建立使用者
• 刪除使用者
• 更新使用者資訊

角色管理

角色本質上是權限的容器。權限會被指派給特定角色中包含的所有使用者。

將角色指派給群組和使用者可以設定其權限。這些權限可用於在 Web 介面中或透過該 API 設定檔案的權限。 它們還可以控制使用者或群組是否可以存取特定 API。

Printers API

Printers API (有時稱為 Print Management API) 可處理所有印表機相關作業。 這些作業包括查詢連接的印表機，取得印表機資訊以及列印工作狀態。目前，沒有用於查詢列印歷程記錄的 API 呼叫。

許多 API 呼叫都由 Print Controller 服務處理，該服務與用戶端電腦上本機執行的 Print Gateway 服務進行通訊。

印表機 ID

印表機 ID 用於唯一識別租用戶空間內的印表機。每部印表機依用戶端名稱+印表機名稱識別 

• printer:<clientname>/<printer_name>

例如，如果 Zebra 是一部網路印表機並連接至多個用戶端，則對於這部印表機，每個用戶端都會有自己的印表機 ID。因此，該印表機可能會顯示為 printer:mariopc/Zebra_105、printer:luigipc/Zebra_105 和 printer:bowserpc/Zebra105，以唯一識別要列印至此印表機的用戶端。這不會影響授權，因為授權不是由印表機決定，因此沒有重複。這種識別方式僅用於告訴 Print Controller 服務將工作傳送至何處。

Librarian API

Librarian API 是 REST API，可處理儲存在 Librarian 空間中的檔案和資料夾。您可以將其視為透過 API 呼叫使用的檔案和資料夾管理程式。 它可以存取兩個 Librarian 空間，並且可以處理兩個空間中的檔案和資料夾。Librarian API 無法列印文件。

Librarian URI

Librarian 空間擁有自己的一組 URI，這些 URI 可以識別檔案或資料夾、檔案或資料夾所在的空間，以及從 Librarian 空間內擷取正確版本項目時所需的任何附加資訊。URI 不僅用於 Librarian API 中，而且還在 Action API 中用於參照儲存在 Librarian 空間中的任何檔案。 檔案 URI 由這兩個 API 使用，但資料夾 URI 通常僅由 Librarian API 使用。

URI 的一般語法為

• librarian://<space>/<path>[?parameter1=value1&parameter2=value2]

值和參數可透過 & 鏈結在一起。僅當存在參數時才需要使用 ?。

兩個空間為 Main 和 $temp。

範例 URI

Main 空間

• librarian://Main/Shipping/Label.btw
• librarian://Main/MyLabel.btw?version=3

$temp 空間

• librarian://$temp/Work/File.txt
• librarian://$temp/label.btw

Actions API

Cloud Action API 會告訴 Cloud 自動執行或更新列印工作。這類似於 BarTender REST API，其具有類似的動作，但 Action API 只能接受 YAML 形式的呼叫，並且所具有的動作僅限於在 Cloud 環境中被認為是安全的動作。該 API 中缺少資料庫動作和「執行 SQL」等動作。如需完整清單，請參閱該 API 的說明文件。

除了列印標籤之外，Action API 還可以擷取關於目前正在執行的動作的資訊，以及對資料夾和檔案執行某些動作。 大多數資料夾工作會由 Librarian API 處理。

對其他 API 的依賴

如果您不知道資源的確切位置或正確位址，您可以使用其他 API 來尋找相關資訊：

• 用於尋找檔案位置的 Librarian API。
• 用於尋找印表機名稱和資訊的 Print API。

這些是單獨的 API，您需要多次呼叫才能擷取所需的資訊。如果您已經知道，您可以略過額外的呼叫而立即進行動作呼叫。

其他資源

• REST API 概觀和說明