服务端 REST API 接口介绍

服务端 REST API 接口有两类,一类是提供给 APP 服务器端调用的,主要是完成帐号、群组的创建和管理;另外一类是提供给客户端调用的,主要提供给最终用户获取离线消息,获取登录服务器地址等,提供给客户端的接口详见:客户端 RSET 相关接口

服务端 API 调用签名规则

面向 APP 应用服务端的 API 接口的请求使用OAuth2客户端证书授权(client_credentials)的方式。

发起请求前需要获取 Token ,如果 Token 失效需要重新获取。

每次请求 API 接口时,均需要提供以下 HTTP Request Header,具体如下:

参数 解释 是否必须 例子
Authorization: Bearer #{token} OAuth2 认证 Token Authorization: Bearer b3dcaffa-0bfb-4d3d-8090-e33fd2e77197

OAuth2 Token 获取方法

  • 请求URL : /oauth/token
  • 请求方式 : POST
  • 请求参数
    • client_id(必填): 露脸云平台为App应用分配的APP_KEY
    • client_secret(必填): 露脸云平台为App应用分配的APP_SECRET
    • grant_type(必填): client_credentials
  • 响应
{
     "access_token":"2140bf83-5cb5-41c4-9398-8a39a7d25b7d","token_type":"bearer",
     "expires_in":199999,"scope":"read"
}

服务端 REST API 返回格式说明

所有的服务端 REST API 调用 HTTP 状态码返回为 200, 如果不是 200 ,表示调用失败;返回的数据格式为json,参考如下:

{
   "error_code":2000,
   "user": {
        "id":"xxx",
        "session_id":"xxx"
    }
}

error_code 表示调用返回的状态码,2000 表示处理正常,4xxx 表示处理错误;如果返回 4xxx,则包含 error 字段,内容是错误信息。