BarTender Cloud REST API 應用程式類型
问题
哪些类型的应用程序可以对 REST API 进行 RESTful 调用?有什么区别?
适用范围
BarTender Cloud REST API
Automation 订阅
回答
进行 REST API 调用时,应用程序必须在 API 网关处理调用之前发送令牌并获得授权。两种类型的应用程序都需要令牌才能通过安全门,但获取令牌的方法不同。
两种类型的应用程序分别是:
- 专用/直接应用程序 - Insomnia、Postman 等
- Web 应用程序 - 自定义应用程序
专用应用程序
专用应用程序,有时称为直接应用程序,会将 API 调用直接发送到 REST API,并且不会在这些 API 调用之外进行任何额外的调用。Insomnia 和 Postman 等应用程序属于此类别。
直接应用程序会使用令牌通过安全门进行 API 调用。
您必须从 Cloud 的 Web 界面中手动检索令牌,其位于您的个人资料设置或“管理云帐户”中的 Cloud API 部分下:
对于直接应用程序,安全令牌必须与所有 API 调用一起发送。 例如,在 Insomnia 中,“身份验证”选项卡可以携带安全令牌。安全令牌被列为持有者令牌(来自 Insomnia 的消息持有者提供的授权令牌)。选择令牌选项后,将令牌粘贴进去,它将随 API 消息一起传送。
Web 应用程序
Web 应用程序是用 C# 等语言构建的功能齐全的界面。它允许用户交互,包括登录以向 Cloud 进行身份验证。这些类型的应用程序需要执行额外的步骤来检索令牌,然后最终通过安全门进行 API 调用。下面是授权过程的流程图。
这看起来需要执行很多额外的步骤,那么为什么还要选择此类型的应用程序,而不是直接应用程序呢? OAuth 身份提供者的身份验证过程会在每次登录时刷新安全令牌,用户永远不必直接处理令牌。一切都由 OAuth 和应用程序本身来处理。应用程序拥有有效令牌后,它就可以开始发送 API 调用并通过安全门。
Web 应用程序必须在 Cloud 本身上注册。这可确保只有授权的应用程序才能使用 Cloud。任何未经授权的访问都会被拒绝。注册位于 Cloud Web 界面上,用户个人资料设置或“管理云帐户”中的 Cloud API 部分下。
注册 Web 应用程序时,系统会询问您一些有关应用程序本身的问题。为了确保在正确的位置输入正确的信息以及正确注册应用程序,每个字段都有一个清晰明了的简短描述,例如保存名称和描述。
所有应用程序都将显示在“Web 应用程序注册”部分下的列表中。
在启动时,将有几个示例说明如何编写自定义 Web 应用以及如何生成身份验证对话框。您可以单击此处以在我们的 BarTender Cloud 帮助中找到相关内容和更多信息。