API 文档
搜索文档…
客户网站用户授权(同步用户标识)

接口

1
POST /api/v2/partner/user/login
Copied!

授权

请求 header
1
Authorization: Bearer <accessToken>
2
Content-Type: application/json
Copied!
注:请将上方的 <accessToken> 替换为分配给您的秘钥串。关于如何获取 accessToken ,请咨询杨经理(18968187008)。
注意:该接口需要进行第三方登录定制服务后才可以使用,具体请联系所属商务经理。

参数

以下参数需要在 body 中提供
参数
参数类型
参数说明
是否必填
uid
string
唯一标识用户的 ID (不论 uid 是数字类型还是字符串类型,都必须转为字符串)
cookieId
string
为每个访客在 cookie 中生成的唯一标识(par.shangzhibo.sid)

请求示例:

1
curl -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>" -X "POST" http://shangzhibo.tv/api/v2/partner/user/login -d #x27;{"uid":"xxxx","cookieId":"xxxxx"}'
Copied!

用户数据标识同步完成后,需要开发者将 cookieId(假设为 123456789) 传递到上直播在进行访问

标识已同步用户请求示例

1
curl -H "Content-Type: application/json" -b 'par.shangzhibo.sid=123456789' "http://<自定义域名>/watch/:id"
Copied!

特殊情况说明

APP 环境或者未定制上直播播放域名的客户可能无法使用 cookie(par.shangzhibo.sid) 方式,此时可以将访客唯一标识通过播放页 URL 后加参数带过来。
http://<自定义域名>/watch/{activityId}?parSid=xxxxx
并将 parSid 仍通过本接口 cookieId 字段传给上直播。
如果参数里面含有特殊字符(如:+/ 等在 URL具有含义的字符) 需要对参数进行 URI encode。
1
let parSid = 'rcTDGfQv7p8P+g//DZ0wFQ=='
2
parSid = encodeURIComponent(parSid)
3
// parSid === 'rcTDGfQv7p8P%2Bg%2F%2FDZ0wFQ%3D%3D'
Copied!
1
curl -H "Content-Type: application/json" "http://<自定义域名>/watch/:id?parSid=123456789"
Copied!

响应 (200)

参数

参数
类型
参数说明
result
boolean
user
object
用户信息

user 参数内容:

参数
参数类型
参数说明
id
integer
主键
uid
string
唯一标识用户的 ID
nickname
string
用户昵称(最长 45 位)
avatar
string
用户头像
sex
string
用户性别(male、female、unknown)
country
string
国家(最大 20 位)
province
string
省份 (最大 20 位)
city
string
城市 (最大 20 位)
createdAt
string
创建时间
updatedAt
string
最后更新时间
owner
integer
其所属的AgentId
openid
string
用户微信服务号 openid, openid 与 uid 一样,都是属于全局唯一字段

响应示例:

1
{
2
"result":true,
3
"user":{
4
"id":95,
5
"nickname":"xxxx",
6
"sex":"male",
7
"owner":233435,
8
"uid":"xxx",
9
"openid": "xxxxxxx",
10
"createdAt":"2019-10-09T03:04:23.000Z",
11
"updatedAt":"2019-10-09T03:04:23.000Z"
12
}
13
}
Copied!

响应(401) 未认证

响应示例

1
{
2
"name":"Unauthorized",
3
"message":"请提供正确有效的 access_token 值",
4
"status":401
5
}
Copied!

响应(403)

响应示例

1
{
2
"name":"Forbidden",
3
"message":"无权访问该接口",
4
"status":403
5
}
Copied!

响应(404)

响应示例

1
{
2
"name":"NotFound",
3
"message":"User Not Found",
4
"status":404
5
}
Copied!
最近更新 8mo ago