保利威账号注册-渠道使用
更新时间:2022-09-02 18:08:07
接口描述
1、给渠道提供保利威账号注册接口。
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/root/user/register
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 企业级appId,由保利威提供 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,其中appSecret为企业级appSecret,由保利威提供,为32位大写的MD5值【详见签名生成规则】 |
| company | true | String | 公司名称,最大长度32 |
| mobile | true | Integer | 手机号,最大长度11 |
| contact | true | String | 联系人,最大长度12 |
| true | String | 邮箱,作为保利威登录账号,同一邮箱不能重复注册 |
示例
http://api.polyv.net/live/v4/root/user/register?company=测试&mobile=17600000000&contact=王测试103&email=wangtest103@polyv.net&appId=idjkeydaex×tamp=1641463824000&sign=690F1DB9678A1D82495BB187F82BC6D8
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| data | Boolean | 请求响应对象【详见Data参数描述】 |
| error | Object | 错误信息【详见Error参数描述】 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| userId | String | 保利威后台userId |
| password | String | 保利威后台登录密码 |
| appId | String | 保利威后台appId |
| appSecret | String | 保利威后台appSecret,请妥善保管,该字段涉及账号安全 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "847f0716fa76461baf8979aaa4415dc3.67.16342672396023837",
"data": {
"userId": "g5lvig1qv6",
"password": "dfs34v",
"appId": "g5lvijo2ef",
"appSecret": "4dd3f125fc43413fb7bc0121bbe33358"
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
