Print Portal 使用者介面和說明文件中提到的根資料夾是，您設定為可在 Print Portal 中使用的資料夾。REST API 將這些資料夾稱為「程式庫」。當您要求列出 (或列舉) 根資料夾時，您會看到此差異。列舉根資料夾 (程式庫) 的內容時，所有子資料夾及其組成項目 (子資料夾或文件) 都將列出。
REST API 是一種軟體架構樣式，用於取得和處理文字表示形式的 Web 資源內容。Print Portal REST API 以 JSON 格式表示資料，因此提交和傳回的資料均為 JSON 格式。
此教學課程中的範例從使用瀏覽器的 URL 要求和回應開始。還有一些 JavaScript 範例，這些範例可用於以程式設計方式建構要求。
對於此教學課程中的步驟，瀏覽器位於安裝 Print Portal 的用戶端上。因此，在 URI 字串中使用 "localhost"。
Print Portal 含有一個稱為 Swagger 的 REST API 規格系統。Swagger 提供有關每個函數的說明以及用於測試要求的執行環境，可作為 REST API 說明系統使用。
|
|
To view the Swagger user interface, add "swagger" after "BarTender" in the BarTender URI, as follows: http://localhost/BarTender/swagger/ |
Swagger 分為兩個部分進行呈現。上方區段包含 API 函數說明以及用於測試 API 要求的功能。下方區段的標題為「模型」，其中提供每個函數及其要求的說明。例如，如果您需要知道什麼是 printRequestID，請前往「模型」區段，然後按一下「PrintRequest」，以顯示引數及其定義的清單，其中之一便是 printRequestID。