杰因网Oauth2登录接入接口指南.docx

杰因网（中教启星）Oauth2 登录接入指南OAuth2.0概述OAUTH协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是OAUTH的授权不会使第三方触及到用户的帐号信息 （如用户名与密码），即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权，因此OAUTH是安全的。oAuth是Open Authorization的简写。目前大部分门户网站和微博类网站，均提供Oauth2协议授权网站用户登录第三方网站，杰因网也提供了Oauth2协议（OAuth协议的下一个版本），方便杰因网用户登录第三方接入网站。大部分API的访问如发表微博、获取私信，关注都需要用户身份，目前中教启星教育平台用户身份鉴权支持通用的OAuth2.0方式。 图1 OAuth2.0 授权流程其中Client指第三方应用，Resource Owner指用户，Authorization Server是杰因网的授权服务器，Resource Server是API服务器。 开发者可以先浏览新浪微博或人人网的OAuth2.0的接口文档和相关SDK，熟悉OAuth2的接口及参数的含义，杰因网的Oauth接口和新浪微博的接口方式几乎一致，如果该网站支持新浪微博用户登录，则使用杰因网的SDK，只需要申请一个SDK的 AppID和AppSecret，就可以使用杰因网用户接入。 接口文档接口说明OAuth2/authorize请求用户授权Token OAuth2/access_token获取授权过的Access Token OAuth2/get_token_info授权信息查询接口OAuth2/revokeoauth2授权回收接口授权页当前一个最完整的授权分为两个步骤：登录-授权。当用户处于登录状态时，页面会自动跳转到授权页，否则需要输入用户密码，同时进行授权，如上图授权页展示那样。 应用场景开发者需要根据各自的应用场景，选择适用的OAuth2.0授权流程： 1、网站或者站外Web应用，请参考：Web应用的验证授权(Authorization Code) 2、桌面和无线客户端应用，请参考：Web应用的验证授权(Authorization Code)，无线客户端可以直接使用官方SDK，通过WebView方式使用授权页。Web应用的验证授权基本流程1. 引导需要授权的用户到如下地址： http://www.YOUR-DOMAIN/api/oauth2/authorize?client_id=YOUR_CLIENT_IDresponse_type=coderedirect_uri=YOUR_REGISTERED_REDIRECT_URI2. 如果用户同意授权,页面跳转至 YOUR_REGISTERED_REDIRECT_URI/?code=CODE 3. 换取Access Token /api/oauth2/access_token?client_id=YOUR_CLIENT_IDclient_secret=YOUR_CLIENT_SECRETgrant_type=authorization_coderedirect_uri=YOUR_REGISTERED_REDIRECT_URIcode=CODE（其中client_id=YOUR_CLIENT_IDclient_secret=YOUR_CLIENT_SECRET可以使用basic方式加入header中） 返回值 { access_token: 7f4175b7f6102d5b60a3ac0b1a031f7875eb2059c469d2f5a2ae7ce22de55, remind_in :3600, expires_in:3600 }4. 使用获得的OAuth2.0 Access Token调用API,例如调用获取用户的基本信息其中http://www.YOUR-DOMAIN/api/users/show.json为获取用户信息接口users/show根据用户ID获取用户信息 URLhttp://www.YOUR-DOMAIN/api/users/show.json支持格式JSONHTTP请求方式GET是否需要登录是访问授权限制访问级别：普通接口请求参数必选类型及范围说明access_tokentruestring OAuth授权后获得的访问参数。uidtruestring需要查询的用户ID。返回结果JSON示例{gender:1,nick_name:点哥洛夫斯基,real_name:刘点兵,uid:ff8080814834b3b8014834c7e13f0000,unit_id:6,unit_name:洪山区第一中学,user_type:10002,user_ty