oauth.token(换取授权访问令牌)
公共请求参数
无。
业务请求参数
参数 | 是否必选 | 字段长度 | 描述 | 示例值 |
grant_type | 必选 | string[1,20] | 授权方式。
| authorization_code |
code | 可选 | string[0,40] | 授权码,用户对应用授权后可获取到授权码。 说明 本参数在 grant_type 为 authorization_code 时必填;grant_type 为 refresh_token 时不填。 | xxx |
refresh_token | 可选 | string[0,40] | 刷新令牌,上次换取访问令牌时得到。 说明 本参数在 grant_type 为 authorization_code 时不填; grant_type 为 refresh_token 时必填,且该值来源于此接口的返回值 app_refresh_token(即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取)。 | xxx |
常见请求示例
curl 'https://xxxx?charset=UTF-8&method=oauth.token&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'refresh_token=xxx' \
-F 'code=xxxxx' \
-F 'grant_type=authorization_code'
本示例仅供参考。
公共响应参数
无。
业务响应参数
参数 | 是否必选 | 字段长度 | 描述 | 示例值 |
access_token | 必选 | string(40) | 访问令牌,通过该令牌调用需要授权类接口。 | xxxxx |
expires_in | 必选 | string(16) | 访问令牌的有效时间,单位为秒。 | 3600 |
refresh_token | 必选 | string(40) | 刷新令牌,通过该令牌可以刷新access_token。 | xxxx |
re_expires_in | 必选 | string(16) | 刷新令牌的有效时间,单位为秒。 | 3600 |
user_id | 和 open_id 二选一 | string(16) | 用户的 userId。 | xxxxx |
open_id | 和 user_id 二选一 | string(128) | 用户的 openId。 | xxxx |
auth_start | 可选 | date(32) | 授权 token 得开始时间,作为有效期计算的起点。 | 2010-11-11 11:11:11 |
响应示例
{
"oauth_token_response": {
"user_id": "xxx",
"open_id": "xxxx",
"access_token": "xxxxxx",
"expires_in": "3600",
"refresh_token": "xxxxxxx",
"re_expires_in": "3600",
"auth_start": "2010-11-11 11:11:11"
},
"sign": "xxxxx"
}
本示例仅供参考。
user.info.share(会员授权信息查询接口)
配合会员授权接口,查询授权信息。
公共请求参数
无。
业务请求参数
无。
常见请求示例
curl 'https://xx?charset=UTF-8&method=user.info.share&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'app_auth_token=${app_auth_token}' \
-F 'auth_token=${auth_token}'
本示例仅供参考。
公共响应参数
无。
业务响应参数
参数 | 是否必选 | 字段长度 | 描述 | 示例值 |
avatar | 必选 | string(400) | 用户头像地址。 重要 如果没有数据(用户未设置)时不会返回该信息,请做好容错。 | - |
city | 必选 | string(20) | 市名称。 | 上海 |
nick_name | 必选 | string(50) | 用户昵称。 重要 如果没有数据(用户未设置)时不会返回该信息,请做好容错。 | 小二 |
province | 必选 | string(20) | 省份名称。 | 安徽省 |
user_id | 和 open_id 二选一 | string(16) | 用户的 userId。 | 2088102104794936 |
open_id | 和 user_id 二选一 | string(128) | 用户的 openId。 | xxxxxx |
gender | 可选 | string(10) | 性别。 枚举值如下:
| F |
响应示例
{
"user_info_share_response": {
"code": "10000",
"msg": "Success",
"user_id": "xxxxxx",
"avatar": "",
"city": "安庆",
"nick_name": "小二",
"province": "安徽省",
"gender": "F"
},
"sign": "xxxxxxx"
}
本示例仅供参考。