微信企业号第三方应用开发[一]——创建套件

清疚 2022-07-17 15:24 277阅读 0赞

注：文中绿色部分为摘自微信官方文档

第三方应用提供给企业的是一个应用，但是应用必须在套件下创建，所以第一步是要创建套件。

**注册成为应用提供商，必须输入以下信息：**

注册条件：a）拥有一个已经过认证的企业号 b）用系统管理员身份进行申请

摘自[http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BA%94%E7%94%A8%E6%8F%90%E4%BE%9B%E5%95%86%E6%B3%A8%E5%86%8C%E5%BA%94%E7%94%A8][http_qydev.weixin.qq.com_wiki_index.php_title_E5_BA_94_E7_94_A8_E6_8F_90_E4_BE_9B_E5_95_86_E6_B3_A8_E5_86_8C_E5_BA_94_E7_94_A8]

**符合以上条件后，登录微信第三方应用官网，选择“服务商登录”**

![729439-20160808131306512-5912937.png][]

### **创建应用套件** ###

开发者完成注册之后，即可创建应用套件。应用套件是第三方应用授权的主体，接口的开发都与应用套件息息相关，请开发者仔细阅读下方内容。

**基本信息：**

<table style="width:640px"> 
 <tbody> 
 <tr> 
 <th>信息项</th> 
 <th>要求及说明</th> 
 </tr> 
 <tr> 
 <td>应用套件Logo</td> 
 <td>应用套件的Logo，小于2M，640*640，在授权页会被用于展示。</td> 
 </tr> 
 <tr> 
 <td>应用套件名称</td> 
 <td>应用套件的名称，2-16个字</td> 
 </tr> 
 <tr> 
 <td>介绍网站</td> 
 <td>介绍该应用套件网站或者页面</td> 
 </tr> 
 <tr> 
 <td>应用套件介绍</td> 
 <td>描述该应用套件所提供的服务，4-120个字</td> 
 </tr> 
 <tr> 
 <td>授权方式</td> 
 <td>使用方式目前有两种：线上自助注册授权使用和服务商辅助授权使用。</td> 
 </tr> 
 <tr> 
 <td>服务行业</td> 
 <td>该应用套件所服务的行业对象，一个套件只能属于一个服务行业。</td> 
 </tr> 
 <tr> 
 <td>套件标签</td> 
 <td>套件提供的服务类型，如OA办公、CRM、HR、ERP等。一个套件只能拥有一个标签。</td> 
 </tr> 
 </tbody> 
</table>

**注意：**

**1）你应谨慎选择所填写的行业和标签，行业是指可使用该套件企业所属的行业。当应用套件达到一定的活跃度后（授权企业数和日活跃用户数），会自动在企业号第三方官网进行推荐，套件所在的分类将基于所设置的行业和标签。**

**2）授权方式的作用在于区分应用套件是否可以直接从企业号第三方官网发起授权，线上自助注册授权使用是指该应用套件可以直接从企业号第三方官网发起授权，而不跳转服务商网站，该类型的应用套件还可以支持移动端发起应用套件授权；服务商辅助授权使用是指该应用套件必须跳转服务商网站，从服务商网站发起应用套件的授权，该类型的应用套件不支持移动端发起应用套件授权。**

**3）你可以创建或者选择其他开发者已创建的标签。你应该谨慎选择套件标签，用户往往会在企业号中通过标签查找相关联的套件。**

**开发信息：**

<table style="width:640px"> 
 <tbody> 
 <tr> 
 <th>套件参数内容</th> 
 <th>说明</th> 
 </tr> 
 <tr> 
 <td>发起授权域名</td> 
 <td>在该域名下发起的授权请求才可被通过，企业点击授权链接时，企业号会检查该域名是否已登记。</td> 
 </tr> 
 <tr> 
 <td>授权完成回调域名</td> 
 <td>在第三方应用授权流程中，授权成功后会回调该域名，返回临时code。你需用此code换取永久授权码，请尽量将此域名与发起授权域名保持一致。</td> 
 </tr> 
 <tr> 
 <td>系统事件接收URL</td> 
 <td>系统将会把此套件的授权变更事件以及ticket参数推送给此URL，ticket说明详见API接口说明。(填写URL时需要正确响应微信验证URL的请求，具体说明请阅读<a href="http://qydev.weixin.qq.com/wiki/index.php?title=%E5%9B%9E%E8%B0%83%E6%A8%A1%E5%BC%8F" rel="nofollow">“回调模式”</a>)</td> 
 </tr> 
 <tr> 
 <td>Token</td> 
 <td>可任意填写，用于生成签名,校验回调请求的合法性。后续所有托管的企业产生的回调消息都使用该值来解密。</td> 
 </tr> 
 <tr> 
 <td>EncodingAESKey</td> 
 <td>回调消息加解密参数，是AES密钥的Base64编码，用于解密回调消息内容对应的密文。后续所有托管的企业产生的回调消息都使用该值来解密。</td> 
 </tr> 
 <tr> 
 <td>应用套件ID</td> 
 <td>应用套件的编号，相关的接口调用需要使用，由系统生成，不可更改。</td> 
 </tr> 
 <tr> 
 <td>应用套件secret</td> 
 <td>应用套件的密钥，相关的接口调用需要使用。</td> 
 </tr> 
 <tr> 
 <td>白名单IP列表</td> 
 <td>应用套件调用企业号第三方应用API时的合法IP列表，只有白名单内的IP才能正常调用企业号API，后续IP若有修改，需要及时进行列表更新。</td> 
 </tr> 
 </tbody> 
</table>

创建完成之后，系统会告知开发者该应用套件的Suiteid和Suitesecret。[（详见第三方应用接口说明）][Link 1]

** 登陆后界面如下，选择添加应用套件**

![729439-20160808131617527-116871701.png][]

**进入创建套件页面，填写基本资料**

![729439-20160808131814402-1685575965.png][]

**点击下一步，填写开发资料**

**![729439-20160808132427059-1712388228.png][]**

**验证URL有效性**

当你提交以上信息时，企业号将发送GET请求到填写的URL上，GET请求携带四个参数，**企业在获取时需要做urldecode处理**，否则会验证不成功。

<table style="width:640px"> 
 <tbody> 
 <tr> 
 <th>参数</th> 
 <th>描述</th> 
 <th>是否必带</th> 
 </tr> 
 <tr> 
 <td>msg_signature</td> 
 <td>微信加密签名，msg_signature结合了企业填写的token、请求中的timestamp、nonce参数、加密的消息体</td> 
 <td>是</td> 
 </tr> 
 <tr> 
 <td>timestamp</td> 
 <td>时间戳</td> 
 <td>是</td> 
 </tr> 
 <tr> 
 <td>nonce</td> 
 <td>随机数</td> 
 <td>是</td> 
 </tr> 
 <tr> 
 <td>echostr</td> 
 <td>加密的随机字符串，以msg_encrypt格式提供。需要解密并返回echostr明文，解密后有random、msg_len、msg、$CorpID四个字段，其中msg即为echostr明文</td> 
 <td>首次校验时必带</td> 
 </tr> 
 </tbody> 
</table>

企业通过参数msg\_signature对请求进行校验，如果确认此次GET请求来自企业号，那么**企业应该对echostr参数解密并原样返回echostr明文(不能加引号，不能带bom头，不能带换行符)**，则接入验证生效，回调模式才能开启。

摘自[http://qydev.weixin.qq.com/wiki/index.php?title=%E5%9B%9E%E8%B0%83%E6%A8%A1%E5%BC%8F ][http_qydev.weixin.qq.com_wiki_index.php_title_E5_9B_9E_E8_B0_83_E6_A8_A1_E5_BC_8F]

**"系统事件接收URL"响应的代码如下**

![复制代码][copycode.gif]

/**
         * 测试微信企业号第三方应用回调协议
         * @author:leap
         * @MethodName: testWXSaaSCallback 
         * @Description: 
         * @param req
         * @param res
         * @date:2016-8-9
         */
        @RequestMapping(value="testWXSaaSCallback")
        @ResponseBody
        public void testWXSaaSCallback( HttpServletRequest req, ServletResponse res){
            //常量值
            String CORP_ID = "wx9671de0651dbdxxx";    //CorpId, 企业号的普通管理组中可查看
            String SUITE_ID = "tja2312bedd5086xxx";    //套件ID，在套件信息中查看
            String SUITE_SECRET = "LGVT0BrN2DZ7VMTuIPOsudaWuXOE0iM67yHpIs1ofESS4l-jSC8LN9nOnmilhXXX";
            String SUITE_TOKEN = "ssI2AnbgOo40eb0kOxxx";
            String SUITE_ENCODING_AES_KEY = "Pmqgjzwt4yAEK9N6YZ34RKpy6onJD56r8mhCUFG9xxx";
            
            //获取参数
            String msgSignature = req.getParameter("msg_signature");
            String timestamp = req.getParameter("timestamp");
            String nonce = req.getParameter("nonce");
            String echostr = req.getParameter("echostr");    //创建套件时验证回调url时传入
    
            String result = "";
            try {
                if(!Utils.isBlank(echostr)){    //=======验证回调url有效性=======
                    WXBizMsgCrypt wxBizMsgCrypt = new WXBizMsgCrypt(SUITE_TOKEN, 
                            SUITE_ENCODING_AES_KEY, CORP_ID);//注意是CORP_ID
                    result = wxBizMsgCrypt.VerifyURL(msgSignature, timestamp, nonce, echostr);
                    System.out.println(result);
                    res.getWriter().write(result);    //对echostr参数解密并原样返回echostr明文(不能加引号，不能带bom头，不能带换行符)
                }else{
                    //其他操作
                    res.getWriter().write("false");    
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }

![复制代码][copycode.gif]

** **其中类WXBizMsgCrypt由官方提供

[java库(2014年9月24日更新,点击下载)][java_2014_9_24]

注意事项：

1.com\\qq\\weixin\\mp\\aes目录下是用户需要用到的接入企业微信的接口，其中WXBizMsgCrypt.java文件提供的WXBizMsgCrypt类封装了用户接入企业微信的三个接口，其它的类文件用户用于实现加解密，用户无须关心。sample.java文件提供了接口的使用示例。

2.WXBizMsgCrypt封装了VerifyURL, DecryptMsg, EncryptMsg三个接口，分别用于开发者验证回调url、接收消息的解密以及开发者回复消息的加密过程。使用方法可以参考Sample.java文件。

3.请开发者使用jdk1.6或以上的版本。针对org.apache.commons.codec.binary.Base64，需要导入jar包commons-codec-1.9（或commons-codec-1.8等其他版本），我们有提供，官方下载地址：

[http://commons.apache.org/proper/commons-codec/download\_codec.cgi][http_commons.apache.org_proper_commons-codec_download_codec.cgi]

4.异常java.security.InvalidKeyException:illegal Key Size的解决方案：

在官方网站下载JCE无限制权限策略文件（请到官网下载对应的版本， 例如JDK7的下载地址：[http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html][http_www.oracle.com_technetwork_java_javase_downloads_jce-7-download-432124.html] )：

下载后解压，可以看到local\_policy.jar和US\_export\_policy.jar以及readme.txt。如果安装了JRE，将两个jar文件放到%JRE\_HOME% \\lib\\security目录下覆盖原来的文件，如果安装了JDK，将两个jar文件放到%JDK\_HOME%\\jre\\lib\\security目录下覆盖原来文件。

摘自[http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8A%A0%E8%A7%A3%E5%AF%86%E5%BA%93%E4%B8%8B%E8%BD%BD%E4%B8%8E%E8%BF%94%E5%9B%9E%E7%A0%81][http_qydev.weixin.qq.com_wiki_index.php_title_E5_8A_A0_E8_A7_A3_E5_AF_86_E5_BA_93_E4_B8_8B_E8_BD_BD_E4_B8_8E_E8_BF_94_E5_9B_9E_E7_A0_81]

红字部分是必要操作，不可忽略

[http_qydev.weixin.qq.com_wiki_index.php_title_E5_BA_94_E7_94_A8_E6_8F_90_E4_BE_9B_E5_95_86_E6_B3_A8_E5_86_8C_E5_BA_94_E7_94_A8]: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BA%94%E7%94%A8%E6%8F%90%E4%BE%9B%E5%95%86%E6%B3%A8%E5%86%8C%E5%BA%94%E7%94%A8
[729439-20160808131306512-5912937.png]: /images/20220717/c9dddb387dc2411a8666f9a68afebde1.png
[Link 1]: http://qydev.weixin.qq.com/wiki/index.php?title=%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E
[729439-20160808131617527-116871701.png]: /images/20220717/32eec80dd5db4a65a0edc6cea1e6169c.png
[729439-20160808131814402-1685575965.png]: /images/20220717/8ce29ff2c06f4b5fb1da94ee463c00f0.png
[729439-20160808132427059-1712388228.png]: /images/20220717/0662c53701fd452591786e94d352a981.png
[http_qydev.weixin.qq.com_wiki_index.php_title_E5_9B_9E_E8_B0_83_E6_A8_A1_E5_BC_8F]: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%9B%9E%E8%B0%83%E6%A8%A1%E5%BC%8F
[copycode.gif]: /images/20220717/b6e16405a1864dddb071e685ee08c598.png
[java_2014_9_24]: http://qydev.weixin.qq.com/download/java.zip
[http_commons.apache.org_proper_commons-codec_download_codec.cgi]: http://commons.apache.org/proper/commons-codec/download_codec.cgi
[http_www.oracle.com_technetwork_java_javase_downloads_jce-7-download-432124.html]: http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html
[http_qydev.weixin.qq.com_wiki_index.php_title_E5_8A_A0_E8_A7_A3_E5_AF_86_E5_BA_93_E4_B8_8B_E8_BD_BD_E4_B8_8E_E8_BF_94_E5_9B_9E_E7_A0_81]: http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8A%A0%E8%A7%A3%E5%AF%86%E5%BA%93%E4%B8%8B%E8%BD%BD%E4%B8%8E%E8%BF%94%E5%9B%9E%E7%A0%81