OAuth2协议标准

本文介绍OAuth2应用如何与MaxKey进行集成。

认证流程

采用Authorization Code获取Access Token的授权验证流程又被称为Web Server Flow，适用于所有Server端的应用。其调用流程示意图如下：

对于应用而言，其流程由获取Authorization Code和通过Authorization Code获取Access Token这2步组成。

1.引导需要授权的用户到如下地址：

http://sso.maxkey.top/sign/authz/oauth/v20/authorize?client_id=YOUR_CLIENT_ID&response_type=code&redirect_uri=YOUR_REGISTERED_REDIRECT_URI 

2.页面跳转至

YOUR_REGISTERED_REDIRECT_URI/?code=CODE

3.换取Access Token

http://sso.maxkey.top/sign/authz/oauth/v20/token?client_id=YOUR_CLIENT_ID&client_secret=YOUR _SECRET&grant_type=authorization_code&redirect_uri=YOUR_REGISTERED_REDIRECT_URI&code=CODE

返回值

{ "access_token":"SlAV32hkKG", "remind_in ":3600, "expires_in":3600 }

应用注册

应用在MaxKey管理系统进行注册，注册的配置信息如下

API接口标准

接口	说明	详细说明
/authz/oauth/v20/authorize	请求用户授权Token	http://sso.maxkey.top/sign接收app sso认证请求, client_id为需要认证的应用的id;
/authz/oauth/v20/token	获取授权过的 Access Token	后台应用获取 code ，调用接口进行 code 校验； 校验成功获取访问 token
/api/oauth/v20/me	授权用户信息查询接口	通过访问 token 获取登录用户信息

授权接口

/authz/oauth/v20/authorize

请求用户授权Token

接口名称	请求用户授权Token
url	http://sso.maxkey.top/sign/authz/oauth/v20/authorize
请求方式	http get/post

请求参数

参数	说明
client_id	注册应用时分配的client_id。
redirect_uri	应用回调地址，注册时需要配置
grant_type	授权类型。
etc param	其他参数。
响应返回app应用程序，包含请求参数如下：
http://app.maxkey.org/app/callback?code =PQ7q7W91a-oMsCeLvIaQm6bTrgtp7
code	用于调用/authz/oauth/token，接口获取授权后的访问token。

令牌接口

/authz/oauth/v20/token

通过/authz/oauth/v20/token用code换取访问token

接口名称	token 接口
url	http://sso.maxkey.top/sign/authz/oauth/v20/token
请求方式	http get/post

请求参数

参数	说明
client_id	注册应用时分配的client_id。
client_secret	注册应用时分配的client_secret
redirect_uri	应用回调地址，注册时需要配置
code	调用authz/oauth/v20/authorize获得的code值。
grant_type	授权类型。Grant type
username	当grant_type=password时，此参数表示直接认证用户名。
password	当grant_type=password时，此参数表示直接认证用户密码。
etc param	其他参数
实际请求如下： The actual request might look like: POST /authz/oauth/v20/token token HTTP/1.1 Host: sso.maxkey.org/openapi Content-Type: application/x-www-form-urlencoded code= PQ7q7W91a-oMsCeLvIaQm6bTrgtp7& client_id=QPKKKSADFUP876& client_secret=client_secret& redirect_uri=http://app.maxkey.org/app/callback
返回数据
A successful response to this request contains the following fields:
access_token	用该token能调用SSO的API
成功返回JSON数据，如下：