自动化教程 |
本自动化教程介绍如何配置 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。