Splashtop 开放 API

Splashtop 现在提供开放 API,使用户能够简化工作流程,提高支持水平。

这些 RESTful API 适用于所有 Splashtop Enterprise 团队。

使用其他 Splashtop 产品的客户可以点击注册参加 beta 测试。

文档

下载最新的开放 API 参考资料:

Splashtop Open API Reference V0.6

可用的 API

通过用于各种 Web 控制台操作的 API,可以自动执行通常要在 Splashtop Web 控制台手动执行的任务。

  • 检索用户信息(用户列表、访问权限)
  • 检索计算机信息(计算机列表、计算机基本信息、清单)
  • 管理计算机(删除计算机、分配计算机到组)
  • 管理组(创建、编辑、删除、分配用户/计算机)
  • 检索日志(会话、配置历史记录、端点管理等)

通过用于集成 Splashtop 有人值守支持 API,可以创建类似于通过我们与 ServiceNow、Freshservice、Jira Service Desk、Zendesk 等平台的预构建集成才能实现的工作流程。

  • 创建支持会话链接
  • 启动会话并连接到最终用户的计算机
  • 将文档(会话日志、文件传输日志、聊天记录等)写回表单

今后我们将继续增加 API,提供更多其他服务。
详见我们的未来工作(路线图)

 

身份验证

可采用以下两种方式完成身份验证和授权。

API 令牌(仅限 Splashtop 团队所有者和超级管理员)
  1. 到网站 my.splashtop.com / my.splashtop.eu 登录 Web 控制台
  2. 点击管理 > 设置 > API
  3. 点击创建 API 令牌
    pcp_api_zh-cn.png
  4. 配置 API 令牌的范围有效期限
    pcp-api-config_zh-cn.PNG
OAuth 2.0
  1. 通过此表格与我们联系,为您的商业软件或 Splashtop 账户添加 OAuth 2.0 应用,并提供相应的客户端 ID客户端密钥。此外,您还需要向我们提供重定向 URL
  2. 从 Web 控制台 my.splashtop.com / my.splashtop.eu 申请身份验证码,可采用以下格式:

    格式
    https://my.splashtop.com/oauth2/authorize?client_id=<client_id>&scope=<scope>&response_type=code&state=<string>&redirect_uri=<callback URL (urlencode)>

    参数
    client_id 我们为您创建的 OAuth 应用的客户端 ID(由 Splashtop 提供)
    范围 以下任意值,用逗号分隔:
    users,psa,service_desk,logs,team_users,team_computers,
    team_groups,team_access_permission,inventory
    状态 定义此变量可确保收到的连接请求是由您发起的身份验证请求。稍后您将使用此状态生成访问令牌。
    redirect_uri URL 编码格式的重定向 URL


  3. 使用身份验证码交换访问令牌刷新令牌。访问令牌的 TTL 为24小时,而刷新令牌的 TTL 为30天。

    有关详细信息,请参阅《Splashtop 开放 API 参考》的第4.1节 OAuth 2.0。
7 人中有 5 人觉得有帮助