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

软件教程 admin 2024-04-24 08:50 348 0

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

BarTender 提供 API 终结点的完整说明文档以及 YAML、JSON 和 BTXML 格式的操作示例。您可以使用ReDoc在安装完BarTender之后查看该文档,ReDoc包含在 BarTender安装文件中。

在设计自己的应用程序以使用 API 之前,您可能想要使用工具来测试如何使用 API。您可以使用多种常用的工具(例如 Insomnia 和 Postman)来访问 API 终结点。

远程连接注意事项

如果要在使用远程连接的计算机上运行 BarTender,请在访问 REST API 以运行 API 和检索 API 文档时考虑以下准则:

  • 必须配置 Microsoft Internet Information Services (IIS) 并在运行 BarTender REST API 的服务器上安装 Print Portal。

  • 要访问 API 终结点,请使用“http://<主机名或 IP 地址>/BarTender/api/actions”。

  • 要访问 ReDoc 文档,请使用“http://<主机名或 IP 地址>/BarTender/api/actions/reference/index.html”。

  • 浏览器可能会提示您输入凭据以进行身份验证。

  • 如果您是域用户并且您正在运行的远程计算机位于同一个 Windows 域中,您可以使用您的域帐户登录。否则,需要该远程计算机的本地帐户。

故障排除

运行 REST API 时,可能会发生以下错误:

  • 401:指示 HTTP 客户端无法登录到 URL 中指定的计算机。

  • 403:指示登录请求来自无权管理集成的用户。要使用 API 运行操作或 BTXML 脚本,必须在 Administration Console 中将用户的“管理集成”权限指定为“允许”。


评论区