uexWeiXin查看3.0文档

• 1、简介
• 2、API概览
• 3、更新历史

接入指引部分：

• 4、获取apk相关的包名和签名
• 5、通过包名和签名申请微信接入AppID
• 6、插件接口调用
• 7、微信支付相关
• 8、回调定制相关
• 9、常见问题
• - 错误返回码说明 - 术语表

1、简介

微信分享插件

1.1、说明

封装了微信开放平台的SDK,集成了微信登录、微信分享功能;可用于实现第三方账号登录,分享内容到朋友圈或好友;

使用前说明： 使用之前须先从微信开放平台申请开发者账号并创建应用,获取 appid 和 secret.同时包含微信支付功能；下一步集成插件API,方可正常使用微信功能。

• 如何申请请参考附录.(相关步骤说明参阅接入指引部分)。

特别说明：

• 1).IDE不建议测试使用,原因:IDE涉及证书和包名问题!　
• 2).安卓微信插件在使用时,调用接口时只需填写对应的参数,直接在线勾选插件使用;Tips:安卓偶尔收不到回调的问题要设置接收回调窗口setCallbackWindowName方法.
• 3).iOS微信插件在使用微信支付或分享过程中,App用过uexWeiXin插件打开微信客户端进行支付,支付过程完成后,微信客户端通过应用自定义的UrlScheme返回到本App,并传回支付结果时,需要配置UrlScheme值;
• AppCan iOS 通用连接（Universal Link）配置说明

通过config.xml配置插件的方法,iOS微信插件可直接在官网公共插件里直接勾选使用,示例配置代码如下:

<config desc="uexWeiXin" type="URLSCHEME">
<urlScheme name="uexWeiXin" schemes="['wxf14d58cec986585b']"/>
</config>

其中'wxf14d58cec986585b'改成您自己申请到的微信appId

4).iOS 9 以后,为了预防APP通过非正常渠道获取用户的某些隐私信息,Apple启用了URLScheme白名单机制。 ​

• 为了正常使用插件的所有功能还需要配置URLScheme白名单(什么是URLScheme白名单)
• 配置白名单方法请参考这里
• uexWeiXin需要进白名单添加的URLScheme如下

<string>wechat</string>
<string>weixin</string>
<string>weixinULAPI</string>

1.2、UI展示

1.3、开源源码

插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

1.4、术语表

Path Types

1.5、错误返回码说明

前端收到的回调中的错误返回码errCode可查看下方链接获取详细信息

微信官方全局返回码说明地址

1.6、接口有效性

本插件所有API默认在插件版本4.0.0+可用.

在后续版本中新添加的接口会在文档中额外说明.

1.7、平台版本支持

本插件的所有API默认支持Android4.0+和iOS7.0+操作系统.

有特殊版本要求的API会在文档中额外说明.

2、API概览

2.1、方法

🍭 registerApp 用户授权

var info = uexWeiXin.registerApp(appID,universalLink)

说明:

必须先向微信终端注册本应用才可以进行其他操作

参数:

iOS 通用连接（Universal Link）配置说明

返回值:

Number类型授权结果,0-成功,1-失败.

示例:

var info = uexWeiXin.registerApp('wxd930ea5d5a258f4f','https://appcan.cn/app/');
alert(info);

isWXAppInstalled //检查微信是否已安装

var info = uexWeiXin.isWXAppInstalled()

说明:

检查微信是否已安装

参数:

无

返回值:

Boolean类型,是否已安装微信,true-已安装,false-未安装.

示例:

var info = uexWeiXin.isWXAppInstalled();
alert(info);

isWXAppSupportApi //判断API是否被支持

var info =uexWeiXin.isWXAppSupportApi()

说明:

判断当前微信的版本是否支持OpenApi,仅iOS支持

参数:

无

返回值:

Boolean类型,判断当前微信的版本是否支持OpenApi,true-支持,false-不支持.

平台支持

iOS10.0+

示例:

var info = uexWeiXin.isWXAppSupportApi();
alert(info);

isSupportPay //判断是否支持支付功能

var info = uexWeiXin.isSupportPay()

说明:

微信5.0以上版本支持支付功能

参数:

无

返回值:

Boolean类型,是否支持支付功能,true-支持,false-不支持.

示例:

  var info = uexWeiXin.isSupportPay();
  alert(info);

getWXAppInstallUrl //获取微信itunes的安装地址

uexWeiXin.getWXAppInstallUrl(cbFun)

说明:

获取微信itunes的安装地址, 仅iOS支持

参数:

回调参数:

var cbFun = function(data){}

平台支持

iOS10.0+

示例:

uexWeiXin.getWXAppInstallUrl(function(data) {
      alert("callback:" + data);
});

getApiVersion //获取SDK的版本号

uexWeiXin.getApiVersion(cbFun)

说明:

获取SDK的版本号, 仅iOS支持

参数:

回调参数:

var cbFun = function(data){}

平台支持

iOS10.0+

示例:

uexWeiXin.getApiVersion(function(data){
    alert("callback:" + data);
});

openWXApp //打开微信

uexWeiXin.openWXApp(cbFun)

说明:

打开微信, 仅iOS支持

参数:

回调参数:

var cbFun = function(data){}

平台支持

iOS10.0+

示例:

uexWeiXin.openWXApp(function(data){
   alert("callback:" + data);
});

shareTextContent //分享文本

uexWeiXin.shareTextContent(jsonData,cbFun)

说明:

分享文本内容到微信

参数:

var jsonData = {
    "text":"中国最大的移动中间键平台AppCan对微信分享的文本支持测试",
    "scene":1
}

各字段含义如下:

回调参数:

var cbFun = function(error){}

示例:

var jsonstr = '{"text":"这是来自AppCan平台对微信支持测试","scene":1}';
uexWeiXin.shareTextContent(jsonstr, function(error){
     alert("callback:" + error);
});

shareImageContent //分享图片

uexWeiXin.shareImageContent(jsonData,cbFun)

说明:

分享图片到微信

参数:

var jsonData = {
    thumbImg:,
    image:,
    scene:,
    title:
}

各字段含义如下:

回调参数:

var cbFun = function(error){}

示例:

 var JsonData = '{"thumbImg":"res://icon.png","image":"res://Default.png","scene":1}';
 uexWeiXin.shareImageContent(JsonData,function(error){
     alert("callback:" + error);
 });

shareLinkContent //分享Link

uexWeiXin.shareLinkContent(jsonData,cbFun)

说明:

分享Link到微信

参数:

var json = {
    thumbImg:,
    wedpageUrl:,
    scene:,
    title:,
    description:
}

各字段含义如下:

回调参数:

var cbFun = function(error){}

示例:

var JsonData = '{"thumbImg":"res://icon.png","wedpageUrl":"http://www.appcan.cn","scene":1,"title":"你好,我是AppCan","description":"你好,我是AppCan描述"}';
uexWeiXin.shareLinkContent(JsonData,function(data){
       alert("callback:" + JSON.stringify(data));
});

getPrepayId //生成预支付订单

uexWeiXin.getPrepayId(json,cbFun)

说明:

生成预支付订单

参数:

请求参数说明及生成办法详见微信开放平台文档统一下单接口参数说明中的"请求参数"

var json = {
    appid:,//(必选) 微信分配的公众账号ID(企业号corpid即为此appId) 
    mch_id:,//(必选) 微信支付分配的商户号
    device_info:,//(可选) 终端设备号(门店号或收银设备ID),注意:PC网页或公众号内支付请传"WEB"
    nonce_str:,//(必选) 随机字符串,不长于32位.随机字符串,不长于32位.
    body:,//(必选) 商品或支付单简要描述
    detail:,//(可选) 商品名称明细列表
    attach:,//(可选) 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
    out_trade_no://(必选) 商户系统内部的订单号,32个字符内、可包含字母
    fee_type:,//(可选) 符合ISO 4217标准的三位字母代码,默认人民币:CNY
    total_fee:,//(必选) 订单总金额,只能为整数,单位为分
    spbill_create_ip:,//(必选) 用户端ip
    time_start:,//(可选) 订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010.
    time_expire:,//(可选) 订单失效时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010.注意:最短失效时间间隔必须大于5分钟
    goods_tag:,//(可选) 商品标记,代金券或立减优惠功能的参数
    notify_url:,//(必选) 接收微信支付异步通知回调地址,通知url必须为直接可访问的url,不能携带参数.
    trade_type:,//(必选) 交易类型,此处为固定值"APP"
    product_id:,//(可选) 此id为二维码中包含的商品ID,商户自行定义.
    openid:,//(可选) 用户在商户appid下的唯一标识.
    sign://(必选) 签名,详见签名生成算法

回调参数:

var cbFun = function(data){}

示例:

var param1 = {
    appid:"wx5h8hdi9o2hs6gd0c5g",
    mch_id:"1234567890",
    device_info:"013467007045764",
    nonce_str:"weradfdgdvccfexs1",
    body:"appcan pay",
    detail:"detail",
    attach:"attach",
    out_trade_no:"1217752501201406033233356018",
    fee_type:"CNY",
    total_fee:"1",
    spbill_create_ip:"127.0.0.1",
    time_start:"20150503152510",
    time_expire:"20150703152510",
    goods_tag:"WXG",
    notify_url:"http://www.baidu.com/",
    trade_type:"APP",
    product_id:"12235413214070356458058",
    openid:"oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
    sign:"8FC5935C38628F44B924C838D760E33E"
};
var data1 = JSON.stringify(param1);
uexWeiXin.getPrepayId(data1,function(data){
   alert("callback:" + JSON.stringify(data));
});

startPay //支付

uexWeiXin.startPay(json,cbFun)

说明:

支付

参数:

请求参数说明及生成办法详见微信开放平台文档调起支付接口参数说明中的"请求参数"

var json ={
    appid:,//(必选)微信分配的AppID
    partnerid:,//(必选)微信支付分配的商户号
    prepayid:,//(必选)微信返回的支付交易会话ID,从gettextareapayId接口的回调方法中获取
    package:,//(必选)暂填写固定值Sign=WXPay
    noncestr:,//(必选)随机字符串
    timestamp:,//(必选)时间戳
    sign://(必选)签名} 
}

回调参数:

var cbFun = function(data){}

示例:

var param1 = {
    appid:"wx5h8hdi9o2hs6gd0c5g",
    partnerid:"1234567890",
    prepayid:"wx201506031538433160984eee0861221810",
    package:"Sign=WXPay",
    noncestr:"weradfdgdvccfexs",
    timestamp:"1412000000",
    sign:"8FC5935C38628F44B924C838D760E33E"
};
var data1 = JSON.stringify(param1);
uexWeiXin.startPay(data1,function(data){
   alert("callback:" + JSON.stringify(data));
});

🍭 openMiniProgram 打开小程序

uexWeiXin.openMiniProgram(JSON.stringify(params));

说明:

打开小程序

参数:

var params = {
    userName:"gh_d43f693ca31f@app",
    path:"",
    miniProgramType:"0"
};
uexWeiXin.openMiniProgram(JSON.stringify(params));

🍭 openChooseInvoice 打开微信选择发票

uexWeiXin.openChooseInvoice(JSON.stringify(params),cbFun);

说明:

打开微信选择发票

参数:

var json = {
}

回调参数:

var cbFun = function(data){}

var data = {
    "cardAry": [
    {
    "cardId": "wx69b6673576ec5a65",
    "encryptCode": "pDe7ajrY4G5z_SIDSauDkLSuF9NI",
    "appID": "O/mPnGTpBu22a1szmK2ogzhFPBh9eYzv2p70L8yzyymSPw4zpNYIVN0JMyArQ9smSepbKd2CQdkv3NvGuaGLaJYjrlrdSVrGhDOnedMr01zKjzDJkO4MOSALnNeDuIpb"
    },{
     "cardId": "wx69b6673576ec5a65",
       "encryptCode": "pDe7ajrY4G5z_SIDSauDkLSuF9NI",
       "appID": "O/mPnGTpBu22a1szmK2ogzhFPBh9eYzv2p70L8yzyymSPw4zpNYIVN0JMyArQ9smSepbKd2CQdkv3NvGuaGLaJYjrlrdSVrGhDOnedMr01zKjzDJkO4MOSALnNeDuIpb"
}]

}

各字段含义如下:

具体发票信息请通过 https://developers.weixin.qq.com/doc/offiaccount/WeChat_Invoice/E_Invoice/Reimburser_API_List.html?#4 5，6 查询报销发票信息 接口获取，相关传入参数已通过本接口返回

login //登录

uexWeiXin.login(json,cbFun)

说明:

微信登录

参数:

var json = {
    scope:,
    state:
}

各字段含义如下:

回调参数:

var cbFun = function(data){}

var data = {
    errCode: "0",
    code: "CODE",
    country: "CN",
    language: "zh_CN",
    state: "0902"
}

各字段含义如下:

示例:

    var params = {
        scope:"snsapi_userinfo,snsapi_base",
        state:"0902"
    };
    var data = JSON.stringify(params);
    uexWeiXin.login(data,function(data){
   alert("callback:" + JSON.stringify(data));
});

getLoginAccessToken //获取access_token

uexWeiXin.getLoginAccessToken(json,cbFun)

说明:

获取access_token

参数:

var json = {
    secret:,
    code:,
    grant_type:
}

各字段含义如下:

回调参数:

var cbFun = function(data){}

var data = {
    access_token: "ACCESS_TOKEN",
    expires_in: 7200,
    refresh_token: "REFRESH_TOKEN",
    openid: "OPENID",
    scope: "snsapi_userinfo",
    unionid:"UNIONID"
}

各字段含义如下:

示例:

    var params = {
        secret:"APP_SECRET",
        code:"CODE",
        grant_type:"authorization_code"
    };
    var data = JSON.stringify(params);
    uexWeiXin.getLoginAccessToken(data,function(data){
   alert("callback:" + JSON.stringify(data));
});

getLoginRefreshAccessToken //获取刷新access_token

uexWeiXin.getLoginRefreshAccessToken(json,cbFun)

说明:

刷新access_token有效期

参数:

var json = {
    grant_type:,
    refresh_token:
}

各字段含义如下:

回调参数:

var cbFun = function(data){}

var data = {
    access_token: "ACCESS_TOKEN",
    expires_in: 7200,
    refresh_token: "REFRESH_TOKEN",
    openid: "OPENID",
    scope: "snsapi_userinfo"
}

各字段含义如下:

示例:

    var params = {
        grant_type:"refresh_token",
        refresh_token:"REFRESH_TOKEN"
    };
    var data = JSON.stringify(params);
    uexWeiXin.getLoginRefreshAccessToken(data,function(data){
   alert("callback:" + JSON.stringify(data));
});

getLoginCheckAccessToken //检验access_token是否有效

uexWeiXin.getLoginCheckAccessToken(json,cbFun)

说明:

检验access_token是否有效

参数:

var json = {
    access_token:,
    openid:
}

各字段含义如下:

回调参数:

var cbFun = function(data){}

var data = {
    errcode: 0
    errmsg: "ok"
}

各字段含义如下:

示例:

    var params = {
        access_token:"ACCESS_TOKEN",
        openid:"OPENID"
    };
    var data = JSON.stringify(params);
    uexWeiXin.getLoginCheckAccessToken(data,function(data){
   alert("callback:" + JSON.stringify(data));
});

getLoginUnionID //获取用户个人信息

uexWeiXin.getLoginUnionID(json,cbFun)

说明:

获取用户个人信息,UnionID机制,开发者可通过OpenID来获取用户基本信息.特别需要注意的是,如果开发者拥有多个移动应用、网站应用和公众帐号,可通过获取用户基本信息中的unionid来区分用户的唯一性,因为只要是同一个微信开放平台帐号下的移动应用、网站应用和公众帐号,用户的unionid是唯一的.换句话说,同一用户,对同一个微信开放平台下的不同应用,unionid是相同的.

参数:

var json = {
    access_token:,
    openid:
}

各字段含义如下:

回调参数:

var cbFun = function(data){}

var data = {
    openid: "OPENID",
    nickname: "xxx",
    sex: 2,
    language: "zh_CN",
    city: "",
    province: "",
    country: "CN",
    headimgurl: "xxxx",
    privilege: [],
    unionid: "UNIONID"
}

各字段含义如下:

示例:

    var params = {
        access_token:"ACCESS_TOKEN",
        openid:"OPENID"
    };
    var data = JSON.stringify(params);
    uexWeiXin.getLoginUnionID(data,function(data){
   alert("callback:" + JSON.stringify(data));
});

setCallbackWindowName //设置接收回调方法的窗口名称

uexWeiXin.setCallbackWindowName(json)

说明:

该方法用于设置接收分享、登陆和支付相关回调方法的窗口名称.具体用法见示例.

参数:

var json = {
    windowName:
}

各字段含义如下:

示例:

示例1:

设置起始页(root页面)为接收回调的窗口:

    var params = {
        windowName:"root"
    };
    uexWeiXin.setCallbackWindowName(JSON.stringify(params));

示例2:

设置其他通过uexWindow.open接口打开的主窗口为接收回调的窗口: open调用方法:

    uexWindow.open('share', '0', "share.html", '2', '', '', 4);
    //其中第一个参数(share)即为share.html窗口的窗口名称.

则在share.html中的uexOnload方法中要添加如下代码:

    var params = {
        windowName:"share"
    };
    uexWeiXin.setCallbackWindowName(JSON.stringify(params));

3、更新历史

iOS

API版本: uexWeiXin-4.0.6

最近更新时间:2020-08-04

Android

API版本: uexWeiXin-4.3.8

最近更新时间:2019-08-07

开发者在使用APPCAN平台提供的微信插件时，需要配置相关的包名，AppID和签名。具体步骤如下（以大众版打包为例）：

4、获取apk相关的包名和签名

4.1包名

自定义包名（推荐使用）

APPCAN大众版打包时，在"云端打包"项中可以自定义包名，如下：建议配合使用自定义安卓证书（其中应用打包选项，证书管理里提供一键创建安卓证书功能）。 例如包名为org.zywx.wbpalmstar.widgetone.uexweixin，若该处不填，则为默认包名。

备注：APPCAN平台默认包名（仅供测试参考）

APPCAN平台默认包名为：org.zywx.wbpalmstar.widgetone.uex加上应用id，如下： 则默认的包名为：org.zywx.wbpalmstar.widgetone.uex11370920。

4.2签名

自定义签名 （推荐使用）

在APPCAN 大众版打包时，在“证书管理”项中可以上传应用打包所需的自定义签名文件，并在"云端打包"时，“选择证书”一项选择自定义证书。该证书打出来的包签名应该在生成此证书时可以得到。或者可以通过微信开发平台提供的操作流程获取应用的签名，https://open.weixin.qq.com/cgi-bin/frame?t=resource/res_main_tmpl&verify=1&lang=zh_CN 上下载签名获取工具获取签名，如下：

备注： APPCAN平台默认签名 （仅供测试参考） “云端打包”中“选择证书”一项选择APPCAN测试证书，打包出来的apk的签名即为默认签名，默认（MD5值）为：d382d671c6672cba4b87980992cd9d77

5、通过包名和签名申请微信接入AppID

5.1 注册账号

在微信开放平台https://open.weixin.qq.com/ 注册开发者账号。

5.2 创建应用

注册成功并登陆之后选择“移动应用开发”项的了解更多，如下： 进入如下界面：

点击“创建应用”，进入如下页面：

填写对应信息，在平台信息栏中填入获取的包名和签名，如下：

提交审核。审核通过之后可以在应用详情界面获得AppID和AppSecret，如下：

6、插件接口调用

在使用uexWeiXin插件时，调用uexWeiXin.registerApp(AppID)，传入申请的AppID即可注册成功。之后可调用分享的相关接口。

7、微信支付相关

通过以上方法创建的应用只支持分享到朋友圈和发送给朋友这两个接口，若需要微信支付功能需要另外申请权限，如下： 点击申请开通，申请对应接口的权限。因为该功能申请非常严格，需要很多财务相关信息，比较麻烦，并且APPCAN没有此业务，也没有办法申请，故此不做介绍。

8、回调定制相关

3.0.22及其之前的版本，分享成功或失败不支持回调，需定制插件； 3.1.0及其之后的版本，支持回调，无需配置或定制插件，公共平台直接勾选最新插件版本使用。

9、常见问题

9.1 registerApp接口调用之后返回注册成功，但是分享接口仍然不能调入到微信的联系人列表或者朋友圈界面

该问题的原因是该apk中包名、签名和AppID不配套，需仔细检查在微信开放平台创建应用时填写的包名、签名是不是和在APPCAN平台打包时的包名、签名一致。registerApp接口调用之后返回注册成功并不是检验这三者（即包名、签名和AppID）是否一致的标准，两者无必然联系。

9.2 安卓偶尔收不到回调的问题

要设置接收回调窗口，API接口可以使用setCallbackWindowName方法

9.3 微信分享提示无法分享到微信的问题

当微信分享时提示：“无法分享到微信，用于用户投诉，当前你分享的内容存在诱导分享行为，无法分享到微信”错误，如下图所示

可能原因： (1)、你的应用真的有违规行为，那就没办法。 (2)、你的应用在云端打包Android应用时选择了使用默认AppCan证书所致(大众版打包为AppCan测试证书，企业版打包为AppCan证书) 大众版： 由于测试证书被很多应用所使用，安全性非常低，更有可能有人使用了此证书分享了一些违规信息，导致现在微信官方已将此证书封禁，所有使用该证书签名的App注册的微信应用，微信分享都会出现此问题。（由于iOS与Android在微信开放平台注册时是同一个appid，因此如果Android使用了AppCan测试证书，iOS也会“躺枪”）。

解决方案： 在应用程序云端打包时，先使用证书管理上传安全的自定义证书，再在云端打包上使用安全的自定义证书进行打包，并发布最新版本应用程序。 由于Android的机制不支持中途更换证书，所以发布新版本时需要对用户进行安装引导，详见注意事项。 注意事项： 由于Android的安全机制不支持应用程序更换证书，所以当应用程序的证书改变时，覆盖安装会提示安装失败； 此时应对用户做一定的引导，说明更换证书的特殊原因（微信分享不能正常使用），引导用户先卸载之前的应用程序，安装更换新证书的应用程序。

9.4 微信分享/支付之后，界面一闪而过的现象

有用户在使用的过程中出现过调用分享之后，界面一闪而过的现象，该问题主要是因为打包Apk中的包名签名与微信的AppID不配套导致的。请确认包名签名证书和申请的AppID