com.kdayun.wecom.cp.api

接口 WxCpOAuth2Service

所有已知实现类:

WxCpOAuth2ServiceImpl

public interface WxCpOAuth2Service

 OAuth2相关管理接口.
  Created by BinaryWang on 2017/6/24.
 

作者:

Binary Wang

方法概要

限定符和类型	方法和说明
java.lang.String	buildAuthorizationUrl(java.lang.String state) 构造oauth2授权的url连接.
java.lang.String	buildAuthorizationUrl(java.lang.String redirectUri, java.lang.String state) 构造oauth2授权的url连接.
java.lang.String	buildAuthorizationUrl(java.lang.String redirectUri, java.lang.String state, java.lang.String scope) 构造oauth2授权的url连接 详情请见: http://qydev.weixin.qq.com/wiki/index.php?
WxCpUserDetail	getUserDetail(java.lang.String userTicket) 使用user_ticket获取成员详情.
WxCpOauth2UserInfo	getUserInfo(java.lang.Integer agentId, java.lang.String code) 根据code获取成员信息 http://qydev.weixin.qq.com/wiki/index.php?
WxCpOauth2UserInfo	getUserInfo(java.lang.String code) 用oauth2获取用户信息 http://qydev.weixin.qq.com/wiki/index.php?

方法详细资料

buildAuthorizationUrl

java.lang.String buildAuthorizationUrl(java.lang.String state)

 构造oauth2授权的url连接.
 

参数:

state - 状态码

返回:

url

buildAuthorizationUrl

java.lang.String buildAuthorizationUrl(java.lang.String redirectUri,
                                       java.lang.String state)

 构造oauth2授权的url连接.
 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=企业获取code
 

参数:

redirectUri - 跳转链接地址

state - 状态码

返回:

url

buildAuthorizationUrl

java.lang.String buildAuthorizationUrl(java.lang.String redirectUri,
                                       java.lang.String state,
                                       java.lang.String scope)

 构造oauth2授权的url连接
 详情请见: http://qydev.weixin.qq.com/wiki/index.php?title=企业获取code
 

参数:

redirectUri - 跳转链接地址

state - 状态码

scope - 取值参考me.chanjar.weixin.common.api.WxConsts.OAuth2Scope类

返回:

url

getUserInfo

WxCpOauth2UserInfo getUserInfo(java.lang.String code)
                        throws me.chanjar.weixin.common.error.WxErrorException

 用oauth2获取用户信息
 http://qydev.weixin.qq.com/wiki/index.php?title=根据code获取成员信息
 因为企业号oauth2.0必须在应用设置里设置通过ICP备案的可信域名，所以无法测试，因此这个方法很可能是坏的。

 注意: 这个方法使用WxCpConfigStorage里的agentId
 

参数:

code - 微信oauth授权返回的代码

返回:

WxCpOauth2UserInfo

抛出:

me.chanjar.weixin.common.error.WxErrorException - 异常

另请参阅:

getUserInfo(Integer, String)

getUserInfo

WxCpOauth2UserInfo getUserInfo(java.lang.Integer agentId,
                               java.lang.String code)
                        throws me.chanjar.weixin.common.error.WxErrorException

 根据code获取成员信息
 http://qydev.weixin.qq.com/wiki/index.php?title=根据code获取成员信息
 https://work.weixin.qq.com/api/doc#10028/根据code获取成员信息
 https://work.weixin.qq.com/api/doc#90000/90135/91023  获取访问用户身份
 因为企业号oauth2.0必须在应用设置里设置通过ICP备案的可信域名，所以无法测试，因此这个方法很可能是坏的。

 注意: 这个方法不使用WxCpConfigStorage里的agentId，需要开发人员自己给出
 

参数:

agentId - 企业号应用的id

code - 通过成员授权获取到的code，最大为512字节。每次成员授权带上的code将不一样，code只能使用一次，5分钟未被使用自动过期。

返回:

WxCpOauth2UserInfo

抛出:

me.chanjar.weixin.common.error.WxErrorException - 异常

另请参阅:

getUserInfo(String)

getUserDetail

WxCpUserDetail getUserDetail(java.lang.String userTicket)
                      throws me.chanjar.weixin.common.error.WxErrorException

 使用user_ticket获取成员详情.

 文档地址：https://work.weixin.qq.com/api/doc#10028/%E4%BD%BF%E7%94%A8user_ticket%E8%8E%B7%E5%8F%96%E6%88%90%E5%91%98%E8%AF%A6%E6%83%85
 请求方式：POST（HTTPS）
 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserdetail?access_token=ACCESS_TOKEN

 权限说明：
 需要有对应应用的使用权限，且成员必须在授权应用的可见范围内。
 

参数:

userTicket - 成员票据

返回:

WxCpUserDetail

抛出:

me.chanjar.weixin.common.error.WxErrorException - 异常