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