原生SDK登录态
先决条件 已开通SDK服务 已开通API服务
登录接口
首先获取access_token
注意事项 此接口不支持更新 ,要更新用户信息,请看此接口
请求方式及url
请求方式:POST
接口地址:https://api.xiaoe-tech.com/xe.sdk.account.login/1.0.0
请求参数说明
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
app_user_id | 是 | string | APP用户id |
access_token | 是 | string | 访问token |
sdk_app_id | 是 | string | SDK应用id(SDK配置中的Client ID) |
user_info | 否 | array | 用户信息,注册时可带 |
user_info数据
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
phone | 否 | string | 用户手机号码 |
avatar_url | 否 | string | 用户头像 |
nickname | 否 | string | 用户名 |
gender | 否 | int | 用户性别,0:未知;1:男性;2:女性 |
city | 否 | string | 用户城市 |
province | 否 | string | 用户省份 |
country | 否 | string | 用户国家 |
language | 否 | string | 用户语言,目前为空 |
union_id | 否 | string | 用户的微信union_id |
备注:
- user_info 在注册时可选择性的传入用户信息,请在调用接口时将用户信息补充完整
- union_id和phone不可以同时传,可传递其中任意一个
示例
请求示例
{
"app_user_id" : "xxxxx",
"sdk_app_id" : "SEKeGinyTMTw",
"access_token": "xxxx",
"user_info": {
"phone": "xxxx",
"avatar_url": "url",
"nickname": "xxx"
}
}
响应示例
{
"code": 0,
"msg": "成功",
"data": {
"token_key": "xe_sdk_token",
"token_value": "41eb1cebe1a5b33ee879f3012f796fbb",
"user_id": "u_5bcaab6885e02_PCnohxzDUm",
"sdk_user_id": "15991672530",
"expires": 86400
}
}
目前token_value有效期是1天, 可能变动, 代码里面最好不要写死了.
不能保证token有效期绝对是1天,因为小鹅通店铺有显示设备登陆数功能,很有可能该账号在别的终端登陆后(例如微信H5),会挤掉之前登陆的token,此时token不到1天也会失效,效果就是一进去会去到一个“登陆中”的页面,该页面会有SDK回调通知APP重新做登陆,重新调用account.login接口获取新token重新syncToken即可。
登出接口
请求方式及url
请求方式:POST
接口地址:https://api.xiaoe-tech.com/xe.sdk.account.logout/1.0.0
请求参数
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
app_id | 是 | string | 店铺app_id |
sdk_app_id | 是 | string | SDK应用ID(对应SDK配置的Client ID) |
token | 是 | string | 要登出的token(对应登录接口返回的用户token值) |
access_token | 是 | string | 用户信息,注册时可带 |
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
code | int | 状态码,0表示成功,其他错误码见全局返回码 |
msg | string | 错误信息提示 |
data | array | 返回具体业务所需数据信息 |
示例
请求示例
{
"app_id": "appdRx8JicQ9960",
"sdk_app_id": "xxxx",
"token": "xxx",
"access_token": "xxxx"
}
响应示例
{
"code": 0,
"msg": "token 清理成功",
"data": []
}