简要描述:

  • 获取令牌
    • 适用于授权码模式获取令牌 (开发中)
      • 用户授权获取令牌
      • 刷新令牌
    • 适用于客户端模式获取令牌
  • 前置参数:
参数名 类型 示例值 说明
client_id string dongni 懂你教育开放平台提供的应用id
client_secret string dongni100 懂你教育开发平台提供的应用id对应的密码

接口版本:

版本号 制定人 修订日期
1.0.0 sapluk 2019-06-27
1.0.1 sapluk 2019-09-18
1.0.2 sapluk 2019-10-08

请求URL:

请求方式:

  • POST

请求头:

参数名 是否必须 类型 示例值 说明
Authorization string Basic ZG9uZ25pOmRvbmduaTEwMA== 验证信息,使用 client_id + “:” + client_secret 进行BASE64编码
示例: dongni:dongni100 -> ZG9uZ25pOmRvbmduaTEwMA==

请求参数:

客户端模式
参数名 是否必需 类型 示例值 说明
grant_type string client_credentials 客户端模式
client_id string dongni 应用id。懂你教育开放平台提供的应用id
(开发中)授权码模式
参数名 是否必需 类型 示例值 说明
grant_type string authorization_code 授权码模式
code string code 重定向携带的code,仅允许使用一次
client_id string dongni 应用id。懂你教育开放平台提供的应用id
redirect_uri string http%3A%2F%2F127.0.0.1%3A23456%2 重定向的uri,必须保持一致
(开发中)刷新令牌 - 适用于授权码模式
参数名 是否必需 类型 示例值 说明
grant_type string refresh_token 刷新令牌
refresh_token string e0fdc981-59e0-40a8-aa69-3a0116f55865 刷新token使用的令牌,授权码模式提供

返回示例:

正确时返回:

{
    "status": 0,
    "message": "成功",
    "data": {
        "access_token" : "30bc959f-3f06-4cc7-8eb7-f3234e4c9670",
        "token_type"   : "bearer",
        "refresh_token": "e0fdc981-59e0-40a8-aa69-3a0116f55865",
        "expires_in"   : 24382,
        "scope"        : ["read", "write"]
    }
}

错误时返回:

{
    "status": !0,
    "message": "失败信息",
    "data": null
}
status message
20001 缺少验证信息 Authorization: Basic
20002 客户端验证失败-客户端信息Base64解析错误
20003 客户端验证失败-客户端信息参数错误
20011 请求权限不足: {{requestParams.grant_type}}
20021 客户端模式授权失败,请稍后再试
20022 客户端验证失败-客户端未注册
20023 参数错误-client_id错误
20024 客户端验证失败-客户端密码错误

返回参数说明:

参数名 类型 示例值 说明
access_token string 30bc959f-3f06-4cc7-8eb7-f3234e4c9670 token值,后续请求懂你教育资源信息时提供用于验证权限
token_type string bearer token类型
refresh_token string e0fdc981-59e0-40a8-aa69-3a0116f55865 用于更新 access_token(适用于授权码模式)
expires_in integer 24382 access_token 有效期,单位秒,可使用 refresh_token 更新
scope string read 权限范围。由懂你教育分配给应用。

备注:

  • 更多返回错误代码请看首页的错误代码描述
作者:谢烨宇  创建时间:2019-06-27 18:08
 更新时间:2022-12-20 14:39