接入说明
接入准备
调用接口前需获取开发者ID和开发者Secret。
登录平台,个人中心(用户头像)→用户信息→安全设置,生成(或查看)开发者ID和开发者Secret,如下图
接入URL
https://v3.exlive.cn/
调用流程
- 使用开发者ID和开发者Secret获取令牌
- 凭令牌调用接口
请求格式
- 所有的API请求均为
POST
请求,Content-Type为application/json
。 - POST请求参数以JSON格式发送在请求主体(body)中。
- 以下是一个简单的POST请求示例:
POST /video/webapi/user/login HTTP/1.1
Host: v3.exlive.cn
Content-Type: application/json
{
"id": "ODE5LjU1My4xrY",
"secret": "4cd38c7b501ffd23f27d9509"
}
需要授权的接口要将访问令牌(token)放入请求头(header)的 Authorization 标头里
POST /video/webapi/user/list HTTP/1.1
Host: v3.exlive.cn
Authorization: eyJ0eXAiOiJKV1.eyJjbGllbnRpI6MTM0NDYsInRrazg5NTkwMj.MjYwMjBMzc0YmYy
Content-Type: application/json
{
"name": "张三"
}
响应格式
所有的接口的返回值均为JSON格式。
字段名称 | 字段类型 | 说明 |
---|---|---|
code | int | 响应编码,响应成功时为200,其他值为响应失败,详见响应编码 |
data | object | 响应成功时接口返回的请求对象,响应失败时无此字段 |
message | string | 响应描述,响应失败时为失败原因 |
以下是一个响应成功的返回结果样例
{
"code": 200,
"data": {
"user_id": 100,
"user_name": "admin",
},
"message": "成功"
}
以下是一个响应失败的返回结果样例
{
"code": 500,
"message": "您未登录,请先登录"
}
响应编码
响应编码 | 响应描述 |
---|---|
200 | 成功 |
300 | 参数错误 |
304 | 令牌失效,需重新获取令牌 |
500 | 其他错误 |