快速简介

本文为刚入门Teamheleper AR远程协助的开发者进行服务端对接REST API, 提供快速开发指引。

什么是服务端REST API?

服务端REST API, 是开发者自己的业务服务端, 想通过接口打通业务流程, 获取在远程协助系统的业务数据。

服务端REST API可以提供哪些数据接口?

• 用户的信息注册, 更新和删除;
• 会议记录和详情的获取;
• 会议中聊天记录的获取;

如何进行授权?

Teamhelper AR远程协助服务端, 在对接时使用签名授权的方式调用https接口, 签名方式见生成 signature

如何使用签名进行Restful API调用?

调用接口时, 主要使用到的数据有如下几个关键变量:

• BaseUrl: https://developer.teamhelper.cn/api

• Uri: /user/add POST

• 请求头参数:

  Key	含义	是否必填	类型	备注
  appKey	应用唯一标识	是	String	开发者平台创建应用获取
  accessKey	应用授权唯一标识	是	String	开发者平台创建应用授权获取
  signature	签名值	是	String	签名算法计算得出
  timestamp	签名到期时间戳	是	String	毫秒级时间戳,开发者根据自己的业务系统自定义
  platform	签名端	是	String	可选: SERVER、ANDROID、PC、GLASS

请求参数分类示例:

• QueryString: ?param1=value1&param2=value2

• PathVariable: /user/{userId} PUT

• RequestBody:

  Request Content-Type: application/json

  {
      "userId": "1",
      "nickname": "Nickname",
      "avatarUrl": "https://********/default.jpeg"
  }

响应统一格式:

Response Content-Type: application/json

{
    "code": 200,
    "msg": "success",
    "data": Object
}