如何使用 Open API

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

欲了解更多详情,请点击查看 API 参考资料 或下载 Splashtop_OPEN_API.yaml

要求

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

配置流程

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

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

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

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

1800a20235ccd6bd470edb0b7d8dddd09fd08da671fe56677fa2259bcc2327b8.png

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

API 函数

API 使用 OAuth 2.0基于 REST 进行身份验证,使用 JSON 进行数据通信。API 函数包括:

  • 用户管理
    • 获取用户列表
    • 创建新的 Gateway 用户
    • 单独管理用户信息,包括获取和更新信息(状态、Web 访问、SOS)
    • 管理用户的访问权限,包括获取和更新访问权限
  • 计算机管理
    • 获取计算机列表
  • 组管理
    • 获取组列表
    • 获取单个组的信息
    • 获取单个组中所有用户的列表
    • 获取单个组中所有计算机的列表
    • 管理组的访问权限,包括获取和更新访问权限
  • 日程管理
    • 获取预定访问信息

API 速率限制

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

 

API 文档

2 人中有 2 人觉得有帮助