接口使用场景:
1、 用户登录协会易后,点击小程序按钮,自动跳转到某H5网页地址(小程序也适用)并追加一个临时生成的ticket参数;
2、ticket有效期为3分钟,若是第三方获取到ticket后请尽快使用。
3、三方H5(或小程序)通过ticket调用接口,可返回用户基本信息,ticket使用后立即失效,三方需自行保存用户信息。
注意:所有API接口需携带协会易分发的appId和secret。
获取协会会员基本信息
允许第三方通过此接口获取当前登录会员的基本信息。
URL:https://www.shanghuiyi.com/open/user/baseInfo?ticket=xxx&appId=xxx&secret=xxx Method:GET
请求参数
参数 | 类型 | 约束 |
ticket | String | 30 到 64个字符 |
💡 注意, ticket一次性的,第二次调用将无法查询到数据。
请求示例
https://www.shanghuiyi.com/open/user/baseInfo?ticket=xxx&appId=xxx&secret=xxx
成功响应
条件:请求参数合法。状态码:0
响应示例:响应将会返回用户的基本信息:
{
"data": {
"ownAvatar": "https://xxxx.jpg",
"username": "张三",
"jobName": "会长",
"gender": "男",
"mobile": "188xxxx9999",
"companyName": "xxxx有限公司",
"companyJob": "总经理",
"birthday": "xxx-xx-xx",
"nation": "汉",
"education": "本科",
"politicGroup": "中共党员",
"socialDuty": "xxx",
"email": "xxx@xx.com",
"idCard": "xxxxx"
},
"errmsg": "成功",
"errno": 0
}
返回参数说明
参数名 | 说明 |
errmsg | 状态描述 |
errno | 状态码 |
data | 接口返回数据 |
data数据说明
参数名 | 类型 | 说明 |
ownAvatar | string | 头像 |
username | string | 姓名 |
jobName | string | 会员身份 |
gender | string | 性别 |
mobile | string | 当前用户手机号,中间四位加敏处理 |
companyName | string | 单位名称 |
companyJob | string | 单位职务 |
birthday | string | 生日 |
nation | string | 民族 |
education | string | 学历 |
politicGroup | string | 政治面貌 |
socialDuty | string | 社会职务 |
string | 邮箱 | |
idCard | string | 身份证号,中间几位加敏处理 |
错误响应
条件:请求参数非法。状态码:-1
响应示例:
{
"errmsg": "请求错误",
"errno": -1
}