神牛教 Oauth2 授权登录接口开发文档
1、开发环境
当前API最新版本:V1.0.0.1
最新更新时间:2018-11-17
作者:小黄牛
PHP环境:PHP5.4+
服务器环境:Windows/Linux/Apache/Nginx
简介:本接口的Appid只限于神牛教成员可获取。
2、使用过程
1、生成授权地址进行跳转
2、获得code
状态码
3、使用code
状态码获取access_token
身份凭证
4、使用access_token
获取用户信息
注意:code与access_token
均为一次性授权,不管授权成功与否,这两个参数都会被重置,需要重新在步骤1开始获取。
3、详细使用说明:
接口必备参数:
appid
身份ID
redirect_uri
回调地址
state
开发者自定义参数,可为空
1、开发者先使用上面三个参数,生成跳转URL,让用户进行触发跳转授权,格式如下:
https://xiuxian.junphp.com/oauth2?appid=身份ID&redirect_uri=回调地址&state=用户随机内容
2、当用户点击进入该链接后,会被要求登录后进行授权确认,确认成功后,神牛教服务器会自动生成code
参数,回跳到指点的redirect_uri
地址中,code
参数为get
类型,同时也是会带之前设置的state
参数,例如:
https://blog.junphp.com/shenniujiao.jsp?code=A4N1S6K7CC3FDSETK5MYDBFU34M48CSTJ30NHF7GE2ACRACVLDN7GKPM50X8ZAR5&state=
3、当获得code
后,开发者使用curl
库发送get
请求到指定api中,获取access_token
,格式如下:
https://xiuxian.junphp.com/oauth2/access_token?appid=身份ID&code=状态码
4、当获得access_token
后,开发者再次使用curl
库发送get
请求到api中,获取用户信息,格式如下:
https://xiuxian.junphp.com/oauth2/get_user?appid=身份ID&access_token=身份凭证
5、最后就是完成开发者,自己的注册与自动登录逻辑了。
4、参数说明
https://xiuxian.junphp.com/oauth2
的参数说明如下:
https://xiuxian.junphp.com/oauth2/access_token
的参数说明如下:
https://xiuxian.junphp.com/oauth2/get_user
的参数说明如下:
5、调用DEMO
6、返回值说明
https://xiuxian.junphp.com/oauth2
的返回值为GET参数
,参数说明:
200
表示成功,其余均为失败
https://xiuxian.junphp.com/oauth2/access_token
的返回值为JSON类型
,参数说明:
200
表示成功,其余均为失败
https://xiuxian.junphp.com/oauth2/get_user
的返回值为JSON类型
,参数说明:
200
表示成功,其余均为失败7、状态码说明
状态码 | 说明 |
---|---|
200 | 请求成功 |
10001 | AppId错误 |
10002 | redirect_uri错误 |
10003 | AppId 或 Code错误 |
10004 | AppId 或 Access_Token错误 |
10005 | 服务器异常 |