8000 :new: #3431 【开放平台】增加半屏小程序管理相关接口 · binarywang/WxJava@03f78ca · GitHub
[go: up one dir, main page]
Skip to content

Commit 03f78ca

Browse files
aimmt918aimmt918
authored
🆕 #3431 【开放平台】增加半屏小程序管理相关接口
1 parent 56977a6 commit 03f78ca

File tree

7 files changed

+538
-0
lines changed

7 files changed

+538
-0
lines changed

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxMaErrorMsgEnum.java

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,132 @@ public enum WxMaErrorMsgEnum {
711711
CODE_89255(89255, "code参数无效，请检查code长度以及内容是否正确_；注意code_type的值不同需要传的code长度不一样 ；注意code_type的值不同需要传的code长度不一样"),
712712

713713
// CODE_504002(-504002, "云函数未找到 Function not found"),
714+
715+
/**
716+
* 半屏小程序系统错误
717+
*/
718+
CODE_89408(89408, "半屏小程序系统错误"),
719+
720+
/**
721+
* 获取半屏小程序列表参数错误
722+
*/
723+
CODE_89409(89409, "获取半屏小程序列表参数错误"),
724+
725+
/**
726+
* 添加半屏小程序appid参数错误
727+
*/
728+
CODE_89410(89410, "添加半屏小程序appid参数错误"),
729+
730+
/**
731+
* 添加半屏小程序appid参数为空
732+
*/
733+
CODE_89411(89411, "添加半屏小程序appid参数为空"),
734+
735+
/**
736+
* 添加半屏小程序申请理由不得超过30个字
737+
*/
738+
CODE_89412(89412, "添加半屏小程序申请理由不得超过30个字"),
739+
740+
/**
741+
* 该小程序被申请次数已达24h限制
742+
*/
743+
CODE_89413(89413, "该小程序被申请次数已达24h限制"),
744+
745+
/**
746+
* 每天仅允许申请50次半屏小程序
747+
*/
748+
CODE_89414(89414, "每天仅允许申请50次半屏小程序"),
749+
750+
/**
751+
* 删除半屏小程序appid参数为空
752+
*/
753+
CODE_89415(89415, "删除半屏小程序appid参数为空"),
754+
755+
/**
756+
* 取消半屏小程序授权appid参数为空
757+
*/
758+
CODE_89416(89416, "取消半屏小程序授权appid参数为空"),
759+
760+
/**
761+
* 修改半屏小程序方式flag参数错误
762+
*/
763+
CODE_89417(89417, "修改半屏小程序方式flag参数错误"),
764+
765+
/**
766+
* 获取半屏小程序每日申请次数失败
767+
*/
768+
CODE_89418(89418, "获取半屏小程序每日申请次数失败"),
769+
770+
/**
771+
* 获取半屏小程序每日授权次数失败
772+
*/
773+
CODE_89419(89419, "获取半屏小程序每日授权次数失败"),
774+
775+
/**
776+
* 不支持添加个人主体小程序
777+
*/
778+
CODE_89420(89420, "不支持添加个人主体小程序"),
779+
780+
/**
781+
* 删除数据未找到
782+
*/
783+
CODE_89421(89421, "删除数据未找到"),
784+
785+
/**
786+
* 删除状态异常
787+
*/
788+
CODE_89422(89422, "删除状态异常"),
789+
790+
/**
791+
* 申请次数添加到达上限
792+
*/
793+
CODE_89423(89423, "申请次数添加到达上限"),
794+
795+
/**
796+
* 申请添加已超时
797+
*/
798+
CODE_89425(89425, "申请添加已超时"),
799+
800+
/**
801+
* 申请添加状态异常
802+
*/
803+
CODE_89426(89426, "申请添加状态异常"),
804+
805+
/**
806+
* 申请号和授权号相同
807+
*/
808+
CODE_89427(89427, "申请号和授权号相同"),
809+
810+
/**
811+
* 该小程序已申请，不允许重复添加
812+
*/
813+
CODE_89428(89428, "该小程序已申请，不允许重复添加"),
814+
815+
/**
816+
* 已到达同一小程序每日最多申请次数
817+
*/
818+
CODE_89429(89429, "已到达同一小程序每日最多申请次数"),
819+
820+
/**
821+
* 该小程序已设置自动拒绝申请
822+
*/
823+
CODE_89430(89430, "该小程序已设置自动拒绝申请"),
824+
825+
/**
826+
* 不支持此类型小程序
827+
*/
828+
CODE_89431(89431, "不支持此类型小程序"),
829+
830+
/**
831+
* 不是小程序
832+
*/
833+
CODE_89432(89432, "不是小程序"),
834+
835+
/**
836+
* 授权次数到达上限
837+
*/
838+
CODE_89424(89424, "授权次数到达上限"),
839+
714840
;
715841

716842
private final int code;

‎weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaEmbeddedService.java

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
package me.chanjar.weixin.open.api;
2+
3+
import me.chanjar.weixin.common.error.WxErrorException;
4+
import me.chanjar.weixin.open.bean.result.WxOpenMaEmbeddedListResult;
5+
6+
/**
7+
* 半屏小程序管理服务
8+
* <pre>
9+
* <a href="https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/embedded-management/addEmbedded.html">半屏小程序管理</a>
10+
* </pre>
11+
*
12+
* @author Yuan
13+
* @version 1.0.0
14+
* @date 2024-12-04 16:55:19
15+
*/
16+
public interface WxOpenMaEmbeddedService {
17+
18+
/**
19+
* 添加半屏小程序
20+
* <pre>
21+
* 本接口用于添加半屏小程序
22+
* </pre>
23+
*/
24+
String API_ADD_EMBEDDED = "https://api.weixin.qq.com/wxaapi/wxaembedded/add_embedded";
25+
26+
/**
27+
* 删除半屏小程序
28+
* <pre>
29+
* 用本接口可以删除已经获得授权调用的半屏小程序
30+
* 说明：通过add_embedded接口添加半屏小程序后，可通过当前接口删除已经添加到半屏小程序列表的小程序
31+
* </pre>
32+
*/
33+
String API_DELETE_EMBEDDED = "https://api.weixin.qq.com/wxaapi/wxaembedded/del_embedded";
34+
35+
/**
36+
* 获取半屏小程序调用列表
37+
* <pre>
38+
* 调用本接口可以获取半屏小程序调用列表
39+
* 说明：通过addEmbedded接口添加半屏小程序后，可通过当前接口获取半屏小程序调用列表
40+
* </pre>
41+
*/
42+
String API_GET_EMBEDDED_LIST = "https://api.weixin.qq.com/wxaapi/wxaembedded/get_list";
43+
44+
/**
45+
* 取消授权小程序
46+
* <pre>
47+
* 调用本接口可以取消已经授权的小程序
48+
* 说明：可通过get_own_list接口获取当前半屏小程序已经授权的小程序列表，可通过当前接口取消对某个小程序的调用权限
49+
* </pre>
50+
*/
51+
String API_DELETE_AUTHORIZED_EMBEDDED = "https://api.weixin.qq.com/wxaapi/wxaembedded/del_authorize";
52+
53+
/**
54+
* 获取半屏小程序授权列表
55+
* <pre>
56+
* 调用本接口可以获取半屏小程序授权列表
57+
* 说明：一个半屏小程序可授权给1000个小程序调用，通过该接口可获取已经授权的小程序列表
58+
* </pre>
59+
*/
60+
String API_GET_OWN_LIST = "https://api.weixin.qq.com/wxaapi/wxaembedded/get_own_list";
61+
62+
/**
63+
* 设置授权方式
64+
*/
65+
String API_SET_AUTHORIZED_EMBEDDED = "https://api.weixin.qq.com/wxaapi/wxaembedded/set_authorize";
66+
67+
/**
68+
* 添加半屏小程序
69+
*
70+
* @param embeddedAppId 半屏小程序appId
71+
* @param applyReason 申请理由
72+
* @author Yuan
73+
* @date 2024-12-04 17:33:33
74+
*/
75+
void addEmbedded(String embeddedAppId, String applyReason) throws WxErrorException;
76+
77+
/**
78+
* 删除半屏小程序
79+
*
80+
* @param embeddedAppId 半屏小程序appId
81+
* @author Yuan
82+
* @date 2024-12-04 17:33:33
83+
*/
84+
void deleteEmbedded(String embeddedAppId) throws WxErrorException;
85+
86+
/**
87+
* 获取半屏小程序调用列表
88+
*
89+
* @return {@link WxOpenMaEmbeddedListResult }
90+
* @author Yuan
91+
* @date 2024-12-04 17:33:33
92+
*/
93+
WxOpenMaEmbeddedListResult getEmbeddedList() throws WxErrorException;
94+
95+
/**
96+
* 取消授权小程序
97+
*
98+
* @param embeddedAppId 半屏小程序appId
99+
* @author Yuan
100+
* @date 2024-12-04 17:33:33
101+
*/
102+
void deleteAuthorizedEmbedded(String embeddedAppId) throws WxErrorException;
103+
104+
/**
105+
* 获取半屏小程序授权列表,默认分页起始值为0，一次拉取最大值为1000
106+
*
107+
* @return {@link WxOpenMaEmbeddedListResult }
108+
* @author Yuan
109+
* @date 2024-12-04 17:33:33
110+
*/
111+
WxOpenMaEmbeddedListResult getOwnList() throws WxErrorException;
112+
113+
/**
114+
* 获取半屏小程序授权列表
115+
*
116+
* @param start 分页起始值 ，默认值为0
117+
* @param num 一次拉取最大值，最大 1000，默认值为10
118+
* @return {@link WxOpenMaEmbeddedListResult }
119+
* @author Yuan
120+
* @date 2024-12-04 17:33:33
121+
*/
122+
WxOpenMaEmbeddedListResult getOwnList(Integer start, Integer num) throws WxErrorException;
123+
124+
/**
125+
* 设置授权方式
126+
*
127+
* @param flag 半屏小程序授权方式。0表示需要管理员验证；1表示自动通过；2表示自动拒绝。
128+
* @author Yuan
129+
* @date 2024-12-04 17:33:33
130+
*/
131+
void setAuthorizedEmbedded(Integer flag) throws WxErrorException;
132+
133+
}

‎weixin-java-open/src/main/java/me/chanjar/weixin/open/api/WxOpenMaService.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -738,6 +738,15 @@ WxOpenMaDomainResult modifyDomain(String action, List<String> requestDomains, Li
738738
*/
739739
WxOpenMaPrivacyService getPrivacyService();
740740

741+
/**
742+
* 半屏小程序服务
743+
*
744+
* @return {@link WxOpenMaEmbeddedService }
745+
* @author Yuan
746+
* @date 2024-12-04 18:42:21
747+
*/
748+
WxOpenMaEmbeddedService getEmbeddedService();
749+
741750
/**
742751
* 购物订单
743752
*

0 commit comments

Comments
 (0)
0