WechatOfficial (payment-wechat 1.0.2 API)

java.lang.Object
- org.thlws.payment.wechat.portal.official.WechatOfficial

所有已实现的接口:

WechatApi
```
public class WechatOfficial
extends Object
implements WechatApi
```
微信公众号相关 Token、OpenId 获取等

版本:

1.0

作者:

Hanley Tang | hanley@thlws.com

字段概要
- 从接口继承的字段 org.thlws.payment.wechat.api.WechatApi
  cgi_bin_ticket_getticket, cgibin_add_template, cgibin_send_data, cgibin_set_industry, cgibin_token, close_order, micro_mch_add, micro_mch_qry, oauth2_access_token, oauth2_refresh_token, pay_micropay, pay_orderquery, pay_refund, pay_reverse, pay_unifiedorder, sns_auth_token, sns_userinfo

构造器概要

构造器
构造器和说明

WechatOfficial()

构造器
构造器和说明
`WechatOfficial()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`generateWechatUrl(String appId, String scope, String callback, String bizData)` wechat URL链接生成， scope取值为:snsapi_base[无需用户授权] 或 userinfo[需用户授权] state 为自定义参数,非必须 redirect_uri 微信处理完成后，会直接转向至该地址
`static boolean`	`IsvalidOauthAccessToken(Map<String,Object> mapToken)` 检验授权凭证（access_token）是否有效
`static TokenOutput`	`obtainAccessToken(String appid, String secret)` access_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access_token。
`static JsApiTicketOutput`	`obtainJsApiTicket(String token)` 获取jsapi_ticket，jsapi_ticket是公众号用于调用微信JS接口的临时票据。
`static JsApiTicketOutput`	`obtainJsApiTicket(String appid, String secret)` 功能同上，但不建议使用,token需要中控服务器维护
`static OauthTokenOutput`	`obtainOauthAccessToken(Map<String,Object> mapToken)` 通过code换取网页授权access_token access_token是调用授权关系接口的调用凭证，有效期为2个小时,频率限制:1万/分钟
`static TemplateOutput`	`obtainTemplateId(String access_token, String template_id_short)` 获取微信消息模板ID{根据微信template_id_short得到,实际动作是调用API往 ‘我的模板’ 中添加了模板}
`static UserInfoOutput`	`obtainUserInfo(Map<String,Object> userInfoMap)` 获取微信用户个人信息所需参数：access_token、openid、lang[非必须] lang 国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语，默认为zh-CN 频率限制:5万/分钟
`static OauthTokenOutput`	`refreshOauthAccessToken(Map<String,Object> mapToken)` 刷新access_token（如果需要）当access_token超时后，可以使用refresh_token进行刷新，access_token刷新结果有两种 1.
`static SendDataOutput`	`sendData2wechat(String access_token, String data)` 发送数据至于用户公微信所关注的微信公账号
`static IndustryOutput`	`setupIndustry(String access_token, String industry_id1, String industry_id2)` 设置行业属性

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - WechatOfficial
```
public WechatOfficial()
```
- 方法详细资料
  - obtainOauthAccessToken
```
public static OauthTokenOutput obtainOauthAccessToken(Map<String,Object> mapToken)
```
    通过code换取网页授权access_token access_token是调用授权关系接口的调用凭证，有效期为2个小时,频率限制:1万/分钟
    
    参数:
    
    mapToken - the map token
    
    返回:
    
    the oauth token output
  - refreshOauthAccessToken
```
public static OauthTokenOutput refreshOauthAccessToken(Map<String,Object> mapToken)
```
    刷新access_token（如果需要）当access_token超时后，可以使用refresh_token进行刷新，access_token刷新结果有两种 1. 若access_token已超时，那么进行refresh_token会获取一个新的access_token，新的超时时间； 2. 若access_token未超时，那么进行refresh_token不会改变access_token，但超时时间会刷新，相当于续期access_token。 refresh_token拥有较长的有效期（30天），当refresh_token失效的后，需要用户重新授权。频率限制:5万/分钟
    
    参数:
    
    mapToken - the map token
    
    返回:
    
    the oauth token output
  - generateWechatUrl
```
public static String generateWechatUrl(String appId,
                                       String scope,
                                       String callback,
                                       String bizData)
```
    wechat URL链接生成， scope取值为:snsapi_base[无需用户授权] 或 userinfo[需用户授权] state 为自定义参数,非必须 redirect_uri 微信处理完成后，会直接转向至该地址
    
    参数:
    
    appId - the app id
    
    scope - the scope
    
    callback - the callback
    
    bizData - the biz data
    
    返回:
    
    string
  - obtainUserInfo
```
public static UserInfoOutput obtainUserInfo(Map<String,Object> userInfoMap)
```
    获取微信用户个人信息所需参数：access_token、openid、lang[非必须] lang 国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语，默认为zh-CN 频率限制:5万/分钟
    
    参数:
    
    userInfoMap - the user info map
    
    返回:
    
    user info output
  - IsvalidOauthAccessToken
```
public static boolean IsvalidOauthAccessToken(Map<String,Object> mapToken)
```
    检验授权凭证（access_token）是否有效
    
    参数:
    
    mapToken - the map token
    
    返回:
    
    boolean
  - obtainAccessToken
```
public static TokenOutput obtainAccessToken(String appid,
                                            String secret)
```
    access_token是公众号的全局唯一接口调用凭据，公众号调用各接口时都需使用access_token。开发者需要进行妥善保存。access_token的存储至少要保留512个字符空间。 access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access_token失效。关于网页授权access_token和普通access_token的区别 1、微信网页授权是通过OAuth2.0机制实现的，在用户授权给公众号后，公众号可以获取到一个网页授权特有的接口调用凭证（网页授权access_token），通过网页授权access_token可以进行授权后接口调用，如获取用户基本信息； 2、其他微信接口，需要通过基础支持中的“获取access_token”接口来获取到的普通access_token调用。
    
    参数:
    
    appid - the appid
    
    secret - the secret
    
    返回:
    
    token output
  - obtainJsApiTicket
```
public static JsApiTicketOutput obtainJsApiTicket(String token)
```
    获取jsapi_ticket，jsapi_ticket是公众号用于调用微信JS接口的临时票据。正常情况下，jsapi_ticket 的有效期为7200秒，通过access_token来获取。由于获取jsapi_ticket的api调用次数非常有限，频繁刷新 jsapi_ticket会导致api调用受限，影响自身业务，开发者必须在自己的服务全局缓存jsapi_ticket 。
    
    参数:
    
    token - 普通token
    
    返回:
    
    js api ticket output
  - obtainJsApiTicket
```
public static JsApiTicketOutput obtainJsApiTicket(String appid,
                                                  String secret)
```
    功能同上，但不建议使用,token需要中控服务器维护
    
    参数:
    
    appid - the appid
    
    secret - the secret
    
    返回:
    
    js api ticket output
  - obtainTemplateId
```
public static TemplateOutput obtainTemplateId(String access_token,
                                              String template_id_short)
```
    获取微信消息模板ID{根据微信template_id_short得到,实际动作是调用API往 ‘我的模板’ 中添加了模板}
    
    参数:
    
    access_token - the access token
    
    template_id_short - the template id short
    
    返回:
    
    template output
  - setupIndustry
```
public static IndustryOutput setupIndustry(String access_token,
                                           String industry_id1,
                                           String industry_id2)
```
    设置行业属性
    
    参数:
    
    access_token - the access token
    
    industry_id1 - the industry id 1
    
    industry_id2 - the industry id 2
    
    返回:
    
    industry output
  - sendData2wechat
```
public static SendDataOutput sendData2wechat(String access_token,
                                             String data)
```
    发送数据至于用户公微信所关注的微信公账号
    
    参数:
    
    access_token - the access token
    
    data - json格式数据
    
    返回:
    
    send data output

类 WechatOfficial

字段概要

从接口继承的字段 org.thlws.payment.wechat.api.WechatApi

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

WechatOfficial

方法详细资料

obtainOauthAccessToken

refreshOauthAccessToken

generateWechatUrl

obtainUserInfo

IsvalidOauthAccessToken

obtainAccessToken

obtainJsApiTicket

obtainJsApiTicket

obtainTemplateId

setupIndustry

sendData2wechat