支付宝H5开放文档

关于 Alipay JSSDK

Alipay JSSDK 提供丰富的支付宝原生 API，可以方便调用支付宝提供的能力，达到媲美原生应用的体验，如页面跳转，支付功能等。
如果你的页面需要适配其他客户端，推荐使用BridgeX。

安装使用

页面引入：
<script src="https://gw.alipayobjects.com/as/g/h5-lib/alipayjsapi/3.1.1/alipayjsapi.min.js"></script>

快速开始

Promise 方式：

ap.chooseImage()
  .then(function(result){
    return new Promise(function(resolve, reject) {
      yourImageDom.onload = resolve;
      yourImageDom.onerror = reject;
      yourImageDom.src = result.apFilePaths[0];
    })
  })
  .then(function(){
    return ap.alert('图片加载成功');
  })
  .catch(function(){
    ap.showToast('图片加载失败');
  });

回调方式：

ap.chooseImage(function(res){
  if(res.apFilePaths && res.apFilePaths.length > 0) {
    yourImageDom.onload = function() {
      ap.alert('图片加载成功');
    };
    yourImageDom.onerror = function() {
      ap.showToast('图片加载失败');
    };
    yourImageDom.src = res.apFilePaths[0];
  }
});

ap.confirm('Hello Alipay!', function(result){
  ap.showToast(result.confirm ? '确定' : '取消');
});

其他说明

接口约定

ap.on 开头的 API 是监听某个事件发生的接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数。
ap.off 开头的 API 是移除相应事件监听函数的接口，若传入事件注册（ap.on）时的 CALLBACK 函数，即移除指定的监听函数。若不传入则移除此事件所有监听函数。
如未特殊约定，其他 API 接口都接收两个参数，一个 Object 类型的 OPTION 作为入参，OPTION 中可以指定 success / fail / complete 来接收接口调用结果；还有一个可选参数是 Function 类型的 CALLBACK，作为回调函数等同于 OPTION.complete。接口参数在文档里没有明确定义时，则无须传入。
回调函数的参数始终是 Object 类型，会返回接口调用的结果。注意，并不是每个接口都有回调函数，可在具体接口文档里查看是否定义。
有回调函数的接口均支持 Promise 风格调用。

名称	类型	必填	描述
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

错误约定

Alipay JSSDK 调用出错时 CALLBACK 回调函数的参数里会包含一个特殊的字段 error（Number 类型），作为 API 调用的错误码，示例:

{
  error: 1,
  errorMessage: '接口不存在'
}

error	描述
1	接口不存在
2	参数无效
3	发生未知错误
4	接口无权限

Alipay JSSDK V3.1.1

关于 Alipay JSSDK

安装使用

快速开始

其他说明

接口约定

错误约定