如何使用 Open API

Open API 是一项新功能，允许访问数据并管理用户账户和计算机。此外，还可以使用 Open API 开发应用，将 Splashtop On-Prem 功能集成到企业环境中。请按照以下说明为团队申请 Open API 应用程序。

详细信息请参阅 API 参考资料。

要求

• Splashtop Gateway v3.24.0 或更高版本
• 所购许可证中已启用 Open API

配置流程

1. 确保许可证中的 Open API 已启用。如有任何疑问，请联系销售人员了解更多信息。

2. 使用团队所有者凭据登录 Gateway。

3. 打开管理 > 团队设置 > API，然后在 API 设置页面单击添加 API 应用按钮。

4. 输入 API 应用名称并配置 API 权限（读入或写入），然后单击添加按钮。

• 名称：用于显示的 API 应用程序名称。
• 权限：设置 API 应用程序的 API 权限。
  • 管理：启用此选项后，可使用与用户/访问权限/计算机/组/计划/安全相关的 API。
  • 有人值守的支持（要求 Gateway v3.28.0）：启用此选项后，可使用 psa 相关的 API。
  • 读取：启用该项后，可使用 GET API。
  • 写入：启用该选项后，可以使用 GET/PATCH/POST/PUT/DELETE API。
• 有效日期（要求 Gateway v3.28.0）：设置 API 应用程序的有效日期。当 API 应用程序过期时，将被阻止从该 API 应用程序启动 API。
• 状态：启用 API 应用程序以使用 Open API。

5. 单击复制或另存为.txt，将客户端 ID和客户端密钥保存在安全位置，然后单击确定。

API 简介

API 使用 OAuth 2.0 并基于 REST 进行身份验证，使用 JSON 进行数据通信。

API 速率限制

每个 API 的调用上限为每分钟200次。

API 文档

• API 参考资料