保利威帳號註冊-渠道使用
更新時間: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
}
