用导航打开主题

BarTender REST API 提供 REST 终结点，这些终结点可用于通过 YAML 或 JSON 文件格式或现有的旧版 BTXML 脚本，在非 Windows 平台上或跨网络自动化您的系统。BarTender REST API 支持使用大多数类型的编程语言（包括 C#、Java、Perl 或 Python）以及大多数集成开发环境 (IDE) 来创建自动化脚本。

支持的技术

BarTender REST API 使用 Integration Builder 和 Process Builder 所使用的BarTender集成服务和打印调度器服务。与服务器的通信是通过端口 5159 实现的。

对于发送脚本和接收响应，API 支持 JSON、YAML 和 BTXML 格式的数据负载。A YAML reference document is included in the BarTender installation; for more information, refer to Available Actions in the Actions API.有关 BTXML 的更多信息，请参阅“使用 BTXML 脚本”。

API 支持以下技术：

• 跨域资源共享 (CORS)，以便可以从源自任何地方的网站访问 REST 终结点

• 多种身份验证方案，包括基本身份验证、集成身份验证 (Microsoft Negotiate) 和 Windows 质询/响应 (NTLM)

  出于安全目的，默认情况下会禁用基本身份验证。要启用基本身份验证，可以在 appsettings.json 配置文件中将其设置更改为“true”。此文件安装在以下目录中： C:\Program Files\Seagull\BarTender 2022\net6.0

• 安全 HTTPS

要求

要使用 BarTender REST API，需要满足以下条件：

• 您所运行的 BarTender 2022 版本为自动化版或企业自动化版。

• 已打开端口 5159，以便 API 可以接收 REST 命令。

• 您有权登录到服务器和管理集成（“管理集成”权限在 Administration Console 中配置）。

本部分内容

• 访问 API 以查看终结点说明文档和进行测试

  介绍可用于访问 BarTender REST API 和测试自动化脚本的应用程序。

• Actions API

  介绍可用于创建脚本和提供代码样本的 BarTender REST API 命令。