Alipay Open Docs

https://opendocs.alipay.com/
Admin
Alipay Open Docs is a platform providing documentation, community support, and communication...
Tokens:5,508,840
Snippets:23,043
Trust Score:9.9
Update:6 days ago
Show doc for...
Tokens:
Raw
### Cloud function example using where with get

Source: https://opendocs.alipay.com/cloud/089cb5

Cloud function example that uses `where` to filter documents where class equals 'class-one' and score is greater than 90, then calls `get` to retrieve matching documents.

```JavaScript
const cloud = require("@alipay/faas-server-sdk");

exports.main = async (event, context) => {
  const db = cloud.database();
  return await db.collection('example').where({
    class: 'class-one',
    score: db.command.gt(90),
  }).get();
};
```

--------------------------------

### Initialize Wi-Fi, connect, and listen for connection events

Source: https://opendocs.alipay.com/mini/039u61

This example initializes the Wi-Fi module with my.startWifi, connects to a Wi-Fi network using my.connectWifi, and then listens for the connection event with my.onWifiConnected. The success callbacks log the results. Requires base library 1.11.0 or higher and enterprise Alipay mini program.

```javascript
// 先初始化 Wi-Fi 模块
my.startWifi({
  success: function(res) {
    console.log('startWifi success',res);
    // 连接 Wi-Fi
    my.connectWifi({
      SSID: '', // 你的 Wi-Fi 设备 SSID
      password: '', // 你的 Wi-Fi 设备密码
      success: function(res) {
        console.log('connectWifi success',res)
      }
    });
  }
});
// 监听连接上 Wi-Fi
my.onWifiConnected(function(res) {
  console.log(res.wifi)
})
```

--------------------------------

### Call my.getLaunchOptionsSync and log options

Source: https://opendocs.alipay.com/mini/api/getLaunchOptionsSync

Use this snippet to retrieve the cold start parameters of the mini program. The returned options object contains query, scene, path, referrerInfo, and apiCategory. Note that query is omitted if no startup parameters exist, and referrerInfo may be undefined in some versions.

```javascript
const options = my.getLaunchOptionsSync();
console.log(options);

```

--------------------------------

### Create radial gradient in .js file

Source: https://opendocs.alipay.com/mini/09mocv

Example of using createRadialGradient in a Page's onCanvasReady method. It obtains the canvas node via my.createSelectorQuery(), gets the 2D context, sets start and end circle parameters, creates the gradient, adds color stops, and fills a rectangle.

```JavaScript
Page({
    onCanvasReady() {
        my.createSelectorQuery().select('#canvas').node().exec((res) => {
            const canvas = res[0].node
            const ctx = canvas.getContext('2d')

            // 设置开始圆形的参数
            let startX = 120
            let startY = 110
            let startR = 90

            // 设置结束圆形的参数
            let endX = 40
            let endY = 110
            let endR = 0

            // 创建渐变
            const grd = ctx.createRadialGradient(startX, startY, startR, endX, endY, endR)

            // 设置渐变颜色
            grd.addColorStop(0, "rgba(255, 255, 255, 0)")
            grd.addColorStop(1, "green")

            // 填充渐变
            ctx.fillStyle = grd
            ctx.fillRect(20, 20, 250, 180)
        })
    },

})
```

--------------------------------

### Draw continuous line with CanvasRenderingContext2D.lineTo

Source: https://opendocs.alipay.com/mini/09myd4

Example showing how to use lineTo to draw a continuous line on a 2D canvas. The canvas element with id 'canvas' and type '2d' is required. The onCanvasReady handler uses my.createSelectorQuery() to get the canvas node and context, then sets the subpath start with moveTo and draws lines with lineTo. Note that each lineTo starts from the last point of the current subpath, so lines are continuous; use moveTo to break the line.

```JavaScript
Page({
    onCanvasReady() {
        my.createSelectorQuery().select('#canvas').node().exec((res) => {
            const canvas = res[0].node
            const ctx = canvas.getContext('2d')

            // 设置子路径起始位置
            ctx.moveTo(90, 130)
            ctx.lineTo(95, 25)
            ctx.lineTo(150, 80)
            ctx.lineTo(205, 25)
            ctx.lineTo(210, 130)

            // 绘制线条
            ctx.lineWidth = 15
            ctx.stroke()
        })
    },
})

```

```XML
<canvas id="canvas" type="2d" onReady="onCanvasReady"></canvas>

```

--------------------------------

### my.ix.startApp（刷脸支付/扫码支付）

Source: https://opendocs.alipay.com/iot/01n64w

启动收银台，用户可选择刷脸或扫码支付，返回付款码。

```APIDOC
## my.ix.startApp（刷脸支付/扫码支付）

### Description
启动收银台，用户可选择刷脸或扫码支付，返回付款码。

### Method
N/A

### Endpoint
my.ix.startApp

### Parameters
#### Request Body
- **appName** (String) - 必填 - 固定值 cashier，不能修改。
- **bizNo** (String) - 必填 - 商户业务流水号；需保证在商户端不重复。
- **totalAmount** (String) - 可选 - 订单总金额。入参上限为 100 万元，即单笔订单最大金额不能超过 100 万元。
- **sellerId** (String) - 可选 - 支付 PID。
- **storeId** (String) - 可选 - 门店 ID。
- **phoneNumber** (String) - 可选 - 刷脸支持传入手机号。
- **orderDetail** (JSON) - 可选 - 自定义订单详情（仅用于展示订单相关信息），支持两栏，最多五行。
- **posTimeout** (String) - 可选 - 支付方式选择页超时时间默认为 120，单位为秒，可自定义时长取值范围为大于等于 10 秒，低于 10 秒报错，或设置为（-1）表示不超时。
- **faceLoadingTimeout** (String) - 可选 - 等待获取刷脸支付结果的页面超时时间默认 15，单位为秒，可自定义时长取值范围为 5~180 秒，低于 5 秒或高于 180 秒报错。
- **showScanPayResult** (Bool) - 可选 - 该参数已失效，建议去除或传入 false。
- **scanLoadingTimeout** (String) - 可选 - 扫码支付结果等待页超时时间默认 5 秒，单位为秒，可自定义时长取值范围为 5~180 秒，低于 5 秒或高于 180 秒报错。
- **sceneMode** (String) - 可选 - 传入 POS 代表在连接收银机场景使用，启动收银台时不播报付款引导语音，页面展示电子海报。

### Response
#### Success Response
- **success** (Bool) - 是否成功。
- **barCode** (String) - 刷脸/扫码成功后返回付款码，其中刷脸返回的付款码仅用于当面付 alipay.trade.pay（统一收单交易支付接口）发起支付，barCode 付款码的有效期为 2 分钟。
- **buyerId** (String) - 买家支付宝 user_id，刷脸成功有返回，扫付款码不返回。
- **codeType** (String) - F：代表刷脸。C：代表扫码。
- **deviceSn** (String) - 机具 SN。
- **error** (String) - 失败错误码[仅错误时返回]。
- **errorMessage** (String) - 失败错误信息[仅错误时返回]。
- **ftoken** (String) - 目前无效，请勿使用 ftoken 进行支付。

#### Error Codes
- **102** - 参数错误。
- **1700** - 收银台页面，点击键盘设置，收银台退出并返回错误码 1700。
- **1400** - 收银台正在运行时，重复唤起收银台。
```

--------------------------------

### Example: using collection to get data

Source: https://opendocs.alipay.com/cloud/089cas

Example usage of the collection method within a cloud function. It creates a database instance and calls collection('example').get() to retrieve data.

```TypeScript
const cloud = require("@alipay/faas-server-sdk");

exports.main = async (event, context) => {
  const db = cloud.database()
  return await db.collection('example').get()
};
```

--------------------------------

### Java example for AlipayCommerceIotDeviceUnbindRequest

Source: https://opendocs.alipay.com/iot/05f0z4

Shows how to create an AlipayClient, build an AlipayCommerceIotDeviceUnbindRequest with the business parameters, execute it, and check the response. The example uses the default gateway and RSA2 signing. Note: the example is for reference only.

```Java
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayCommerceIotDeviceUnbindRequest request = new AlipayCommerceIotDeviceUnbindRequest();
request.setBizContent("{" +
"  \"app_type\":\"MINI_APP\"," +
"  \"mini_app_id\":\"2020001181612345 或 \\\"RUYI_LITE\\\"\"," +
"  \"application_id\":\"202000118166789\"," +
"  \"device_id_type\":\"SN\"," +
"  \"biz_tid\":\"01017gV1CZ1XxASNbqkTJqchletNyVXtsKy1PAs4FKZ6tjRMqyMG2Zk\"," +
"  \"supplier_id\":\"201901111100635561\"," +
"  \"device_sn\":\"QCF420190316000107\"," +
"  \"source\":\"2088100020003000\"," +
"  \"external_id\":\"105290059990194\"," +
"  \"merchant_id_type\":\"direct\"," +
"  \"merchant_id\":\"2088101156429885\"," +
"  \"shop_id\":\"2020081700502000000039796029\"," +
"  \"external_shop_id\":\"202000118161234523456789\"," +
"  \"external_id_secret\":\"66c49ead5461bb8aedc87d36111111\"," +
"  \"equipment_type\":\"0\"" +
"}");
AlipayCommerceIotDeviceUnbindResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
```

--------------------------------

### Get compressed file size with FileSystemManager.getFileInfo

Source: https://opendocs.alipay.com/mini/038cu4

Example showing how to get the size of the compressed image file using FileSystemManager.getFileInfo. The size is in bytes.

```javascript
my.chooseImage({
  count: 1,
  success: (res) => {
    my.compressImage({
      apFilePaths: res.apFilePaths,
      compressLevel: 1,
      success: (data) => {
        console.log(data.apFilePaths[0]);
        let fs = my.getFileSystemManager();
        fs.getFileInfo({
          filePath: data.apFilePaths[0],
          success: (res) => {
            console.log(res.size); // 单位是字节（Byte）
          },
        });
      },
    });
  },
});

```
Tokens:
Raw