开发者账号接入文档

来自Flyme开放平台
跳转至: 导航搜索

open api接口

接口调用说明(必读)

1,下面接口都是获取access_token或则通过access_token获取相关信息。

2,目前线上scope说明:

scope 名称 说明
uc_trust 访问用户基本信息 访问用户基本信息:包括头像、昵称
uc_basic_info 校验授权信息 校验基本用户授权信息
uc_high_trust 校验授权信息 校验基本用户授权信息:邮箱、电话

获取授权code

接口调用请求说明

开发者通过本接口,获取到授权code

http请求方式: GET
https://open-api.flyme.cn/oauth/authorize?response_type=code&scope=uc_basic_info&client_id=z5A8pb9zA5bN&state=stateabc&redirect_uri=http://clientxxx.flyme.cn/login.do

参数说明

参数 是否必须 说明
response_type 固定值:code
client_id 客户端clientId
redirect_uri 成功之后的重定向地址
scope 找mplus开放确定索要,包括:
state 接口请求成功后的回调状态位

返回说明

正确时的返回:

 重定向到redirect_url地址,例如上面将会回调地址:http://clientxxx.flyme.cn/login.do?code=
 code就是authCode

code有效期为5分钟

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明

通过授权code获取token

接口调用请求说明

通过code可以拿到授权的token,这个请求可以在服务端发起。。

http请求方式: POST
https://open-api.flyme.cn/oauth/token?grant_type=authorization_code&client_id=z5A8pb9zA5bN&client_secret=6yeUCTvAH3sn6ch69oHZ7a03IkxTNw&redirect_uri=http://clientxxx.flyme.cn/login.do&code=fzpwhm&state=xyz

参数说明

参数 是否必须 说明
grant_type 固定值:authorization_code
client_id 客户端clientId
client_secret 客户端clientSecret
redirect_uri 成功之后的重定向地址
code 授权code
state 接口请求成功后的回调状态位

返回说明

正确时的json返回:

{"access_token":"eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgwMDA3NDQyMjUsInIiOiJ4ZnF0ZFBZY0NwUmRsckYifQ",
"token_type":"bearer",
"refresh_token":"eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgwMDA3NDQyMjYsInIiOiJMdnF5S1lyb0dJZUR3TngifQ",
"expires_in":123122,"scope":"uc_basic_info","open_id":"8mUAF421px8wVt2O3eym3saKtCAkRU-71B3qQBccPFg"}
参数 说明
access_token 访问token,用于授权访问相关接口
token_type token类型,目前只有bearer一种
refresh_token access_token过期后,可以通过refresh_token重新获取
expires_in 过期时间,单位秒
scope 授权类型,不同授权类型的scope对应不同接口的访问权限
open_id open api生成的open id

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明

隐式授权获取token

接口调用请求说明

隐式授权获取token,只需一步请求就可以获取到token,省去中间获取code的过程。

http请求方式: POST
https://open-api.flyme.cn/oauth/authorize?response_type=token&scope=uc_basic_info&client_id=z5A8pb9zA5bN&state=stateabc&redirect_uri=http://clientxxx.flyme.cn/login.do

参数说明

参数 是否必须 说明
response_type 固定值:token
client_id 客户端clientId
scope 授权的scope 多个用空号隔开
redirect_uri 成功之后的重定向地址
state 接口请求成功后的回调状态位

返回说明

正确 流浪器地址将会重定向到 redirect_uri指定的地址,并且带上 access_token等信息。

http://clientxxx.flyme.cn/login.do#access_token=eyJ2IjoxLCJ1IjoiMTQ2MjM1MCIsImEiOiI4ODAyQjQwNzI4RDZBNUYzRjM5REQ1QTkyMjczRTRFOSIsImkiOiJLakZGS0V3bGlLZ3RraXEifQ&token_type=bearer&state=stateabc&expires_in=3599&open_id=8mUAF421px8wVt2O3eym3saKtCAkRU-71B3qQBccPFg
参数 说明
access_token 访问token,用于授权访问相关接口
token_type token类型,目前只有bearer一种
expires_in 过期时间,单位秒
state 请求时候的状态码值
open_id open api生成的open id

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明


授权方式password获取token (过期,这个接口不再被支持

通过refreshToken 重新获取token

接口调用请求说明

http请求方式: POST
https://open-api.flyme.cn/oauth/token

参数说明

参数 是否必须 说明
refresh_token 获取token时返回的refresh_token
client_id 客户端clientId
client_secret 客户端clientSecret
grant_type 授权方式:这个接口对应值应该是refresh_token;

返回说明

正确时的json返回:

{"access_token":"eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgwNDg2OTM0MzUsInIiOiJyY3ZMRnBMTXZEYlV0c2gifQ",
"token_type":"bearer",
"refresh_token":"eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgwNDg2OTM0MzUsInIiOiJaZmxvSkNrUHNWQWVYZVoifQ",
"expires_in":123122,"scope":"uc_basic_info",
"open_id":"8mUAF421px8wVt2O3eym3saKtCAkRU-71B3qQBccPFg"}
参数 说明
access_token 访问token,用于授权访问相关接口
token_type token类型,目前只有bearer一种
refresh_token access_token过期后,可以通过refresh_token重新获取
expires_in 过期时间,单位秒
scope 授权类型,不同授权类型的scope对应不同接口的访问权限
open_id 生成的开放平台 open id

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明

access token 校验

接口调用请求说明

http请求方式: GET
https://open-api.flyme.cn/oauth/check_token?token=eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgwNDg2OTM0MzUsInIiOiJyY3ZMRnBMTXZEYlV0c2gifQ

参数说明

参数 是否必须 说明
token 访问token

返回说明

正确时的json返回:

{"exp":1438171816,"user_name":"1462350","authorities":["ROLE_FLYME"],"client_id":"z5A8pb9zA5bN"}
参数 说明
exp 过期时间,单位秒
user_name 用户名称
authorities 授权方式
client_id clientId

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明

通过access_token获取用户信息

接口调用请求说明

http请求方式: GET
https://open-api.flyme.cn/v2/me?access_token=eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgxNTAzMjU5MDEsInIiOiJ2dnlQTFN4c1BuQnJzdFEifQ

参数说明

参数 是否必须 说明
access_token open api的授权token

返回说明

正确的json返回:

{"code":"200","message":"","redirect":"","value":{"icon":"http://img.res.meizu.com/img/download/uc/14/62/35/00/00/1462350/w200h200",
"nickname":"test_nickname3","openId":"8mUAF421px8wVt2O3eym3saKtCAkRU-71B3qQBccPFg"}
}
参数 说明
code 状态码
message 消息内容
icon 用户头像
nickname 用户昵称
openId 开放平台openId

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明

校验access_token相关信息

接口调用请求说明

http请求方式: GET
https://open-api.flyme.cn/v2/check?access_token=eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgxNTAzMjU5MDEsInIiOiJ2dnlQTFN4c1BuQnJzdFEifQ

参数说明

参数 是否必须 说明
access_token open api的授权token

返回说明

正确的json返回:

{"code":"200","message":"","value":{"scope":[],
"open_id":"8mUAF421px8wVt2O3eym3saKtCAkRU71B3qQBccPFg",
"client_id":"z5A8pb9zA5bN","expired_at":1438273448915},"redirect":""}
参数 说明
code 状态码
message 消息内容
open_id 开放平台openId
client_id clientId
expired_at 过期时间的毫秒表示

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明


获取用户信息(高权限接口)

调用此接口必须是包含了uc_high_trust scope的授权

接口调用请求说明

http请求方式: GET
https://open-api.flyme.cn/v2/high_me?access_token=eyJ1IjoiMTQ2MjM1MCIsInQiOjE0MzgxNTAzMjU5MDEsInIiOiJ2dnlQTFN4c1BuQnJzdFEifQ&open_id=

参数说明

参数 是否必须 说明
access_token open api的授权token
open_id 用户的openId

返回说明

正确的json返回:


{"code":"200","message":"","redirect":"","value":{"email":"test0504@126.com","icon":"http://img.res.meizu.com/img/download/uc/14/62/35/00/00/1462350/w200h200","nickname":"test_nickname4","phone":"13750024127","userId":1462350}}

参数 说明
code 状态码
message 消息内容
email 用户email
icon 用户头像地址
nickname 用户昵称
phone 用户电话
userId 用户userId

错误时会返回错误码等信息,请根据错误码查询错误信息: 全局返回码说明


全局返回说明

参数 说明
400 1)invalid_token 2)账户不存在或者密码错误 3)Invalid authorization code
401 1)权限不对 2)未通过授权
500 1)非法参数 2)参数不完整
100002 token已失效
100003 请使用有效的accessToken

导航菜单