概述及通用规则
为了使用职教资源公共服务平台提供的API(应用程序接口),首先第三方应用需要向平台申请一个专属的App ID
和App Secret
。
AppId
和AppSecret
的使用方式跟其他一些协议中的公钥私钥的方案相类似,您可以使用你所熟悉的编程语言将AppId
和AppSecret
结合,为发出的每个请求添加签名,以此来向职教资源公共服务平台表明自己身份的合法性。
目前职教资源平台使用的用户授权协议是OAUTH2.0版本。 |
该文档描述了职教资源平台为第三方应用所提供的接口,接口主要分为以下三大类:
-
授权服务
-
用户类服务
用户鉴权流程
-
用户登录职教资源平台并点击要进入的第三方应用。
-
职教资源平台跳转到第三方应用的入口URL,第三方应用请求用户给予进入应用的授权。
-
用户同意授权,平台返还给第三方应用授权码。
-
应用使用上一步获得的授权码,向职教资源平台申请令牌,调用申请令牌接口。
-
职教资源平台对第三方应用的授权码进行认证以后,确认无误,发放令牌。
-
应用使用令牌,向职教资源平台申请获取资源,调用查询授权用户信息接口。
-
职教资源平台确认令牌无误,返回给第三方应用登录用户的相关信息。
授权服务API
该类接口遵循OAuth 2.0
标准,有关该协议的详细内容,请参考 OAuth标准。
用户授权-请求授权
向职教资源公共服务平台请求授权,该接口将用户引导到登录页面,并请求用户对应用授权。
请求参数
参数字段 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
response_type |
true |
String |
表示授权类型,此处的值固定为 |
client_id |
true |
String |
表示平台分配的 |
redirect_uri |
false |
String |
表示成功重定向URI。 |
scope |
false |
String |
表示申请的权限范围。 |
state |
false |
String |
表示应用的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值。 |
用户授权-申请用户授权令牌
应用向职教资源平台申请访问令牌(access token)。
请求参数
参数字段 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
grant_type |
true |
String |
表示授权类型,此处的值固定为 |
client_id |
true |
String |
表示应用的 |
redirect_uri |
true |
String |
表示重定向URI,必须与 |
code |
true |
String |
表示 |
用户类服务
以用户为中心的相关接口服务
查询授权的用户信息
根据从用户授权
中得到的access_token向服务器查询用户的基本信息。
返回数据
返回值字段 | 必选 | 类型及范围 | 说明 |
---|---|---|---|
unionid |
true |
String |
第三方唯一标识。 |
nickname |
true |
String |
用户姓名 |
headimgurl |
true |
String |
用户头像 |
sex |
true |
Int |
1:“男”|2:“女” |
返回的用户信息(JSON格式数据): { "unionid ":"100000", "nickname":"隔壁老王" "headimgurl":"/img/1.jpg", "sex":1 }
openid 为用户在职教资源平台中的唯一标识,第三方应用应保存并维护其和自己系统用户的对应关系,便于后续调用职教资源API时传入。
|