net.jlxxw.wechat.function.api

类 OpenApiManager

java.lang.Object

net.jlxxw.wechat.function.api.OpenApiManager

@DependsOn(value="weChatTokenManager")
 @Component
public class OpenApiManager
extends Object

微信 openApi 管理

作者:

chunyang.leng

构造器概要

构造器

构造器和说明
OpenApiManager()

方法概要

限定符和类型	方法和说明
WeChatResponse	clean()
ApiResponse	selectQuota(@NotBlank(message="cgiPath\u4e0d\u80fd\u4e3a\u7a7a") String cgiPath)
ApiRequestRecord	selectRid(@NotBlank(message="rid\u4e0d\u53ef\u4ee5\u4e3a\u7a7a") String rid)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OpenApiManager

public OpenApiManager()

方法详细资料

clean

public WeChatResponse clean()
                     throws WeChatException

返回:

返回码 errmsg 说明
0 ok 查询成功
48006 forbid to clear quota because of reaching the limit 一个月10次的机会用完了
40013 invalid appid appid写错了；或者填入的appid与access_token代表的账号的appid不一致

抛出:

WeChatException - 微信服务端验证出现异常

另请参阅:

文档地址
本接口用于清空公众号/小程序/第三方平台等接口的每日调用接口次数。
1、如果要清空公众号的接口的quota，则需要用公众号的access_token；如果要清空小程序的接口的quota，则需要用小程序的access_token；如果要清空第三方平台的接口的quota，则需要用第三方平台的component_access_token
2、如果是第三方服务商代公众号或者小程序清除quota，则需要用authorizer_access_token
3、每个帐号每月共10次清零操作机会，清零生效一次即用掉一次机会；第三方帮助公众号/小程序调用时，实际上是在消耗公众号/小程序自身的quota
4、由于指标计算方法或统计时间差异，实时调用量数据可能会出现误差，一般在1%以内

selectQuota

public ApiResponse selectQuota(@NotBlank(message="cgiPath\u4e0d\u80fd\u4e3a\u7a7a")
                               @NotBlank(message="cgiPath\u4e0d\u80fd\u4e3a\u7a7a") String cgiPath)
                        throws WeChatException,
                               ParamCheckException

参数:

cgiPath - api的请求地址，例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ，也不要漏了"/",否则都会76003的报错

抛出:

WeChatException - 微信服务端验证出现异常

ParamCheckException - 请求参数检查失败

另请参阅:

文档地址

查询openAPI调用quota

本接口用于查询公众号/小程序/第三方平台等接口的每日调用接口的额度以及调用次数。

  注意事项
 1、如果查询的api属于公众号的接口，则需要用公众号的access_token；如果查询的api属于小程序的接口，则需要用小程序的access_token；如果查询的接口属于第三方平台的接口，则需要用第三方平台的component_access_token；否则会出现76022报错。
 2、如果是第三方服务商代公众号或者小程序查询公众号或者小程序的api，则需要用authorizer_access_token
 3、每个接口都有调用次数限制，请开发者合理调用接口
 4、”/xxx/sns/xxx“这类接口不支持使用该接口，会出现76022报错。
 

selectRid

public ApiRequestRecord selectRid(@NotBlank(message="rid\u4e0d\u53ef\u4ee5\u4e3a\u7a7a")
                                  @NotBlank(message="rid\u4e0d\u53ef\u4ee5\u4e3a\u7a7a") String rid)
                           throws WeChatException,
                                  ParamCheckException

参数:

rid -

抛出:

WeChatException - 微信服务器验证异常

ParamCheckException - 请求参数检查失败

另请参阅:

文档地址 查询rid信息 本接口用于查询调用公众号/小程序/第三方平台等接口报错返回的rid详情信息，辅助开发者高效定位问题

     注意事项
 1、由于查询rid信息属于开发者私密行为，因此仅支持同账号的查询。举个例子，rid=1111，是小程序账号A调用某接口出现的报错，那么则需要使用小程序账号A的access_token调用当前接口查询rid=1111的详情信息，如果使用小程序账号B的身份查询，则出现报错，错误码为xxx。公众号、第三方平台账号的接口同理。

 2、如果是第三方服务商代公众号或者小程序查询公众号或者小程序的api返回的rid，则使用同一账号的authorizer_access_token调用即可

 3、rid的有效期只有7天，即只可查询最近7天的rid，查询超过7天的rid会出现报错，错误码为76001