更新记录

1.0.4（2020-12-30） 下载此版本

优化已知问题

1.0.3（2020-12-30） 下载此版本

优化已知问题

1.0.2（2020-05-23） 下载此版本

• 重新整理插件功能

平台兼容性

云端兼容性

云函数类插件通用教程

使用云函数类插件的前提是：使用HBuilderX 2.9+

openapi简介

mp-cloud-openapi是uniCloud提供的微信、支付宝等小程序云端能力的封装。比如获取小程序码等。开发者无需关心请求发送、加密、平台差异等问题，只需要关注输入和输出即可。

注意

本插件不包括登录、支付、订阅消息、内容安全。这4部分官方有单独的插件。

• uni-id：全端的、云端一体的账户系统。
• uni-pay：全端的、云端一体的支付系统。
• uni-subscribemsg：小程序和公众号订阅消息/模板消息。
• 内容安全：校验入库的文字、图片安全性，避免违法违规

引入mp-cloud-openapi

// 插件市场导入的引入方式
const openapi = require('mp-cloud-openapi')

微信小程序平台

直接使用微信开放能力，参数名与微信服务端api相对应，只是转为了驼峰形式。返回值也转为了驼峰形式

初始化

入参说明

返回值说明

返回openapi实例用以调用微信开放能力

示例代码

const openapiWeixin = openapi.initWeixin({
  appId: 'appId',
  secret: 'secret'
})

小程序码

wxacode.createQRCode

获取小程序二维码，适用于需要的码数量较少的业务场景。通过该接口生成的小程序码，永久有效，有数量限制.

openapiWeixin.wxacode.createQRCode

入参说明

返回值说明

包含二进制数据及其数据类型的对象

使用示例

exports.main = async (event, context) => {
  try {
    const result = await openapiWeixin.wxacode.createQRCode({
        path: 'page/index/index',
        width: 430
      })
    return result
  } catch (err) {
    return err
  }
}

wxacode.get

获取小程序码，适用于需要的码数量较少的业务场景。通过该接口生成的应用码，永久有效，有数量限制.

入参说明

返回值说明

使用示例

exports.main = async (event, context) => {
  try {
    const result = await openapiWeixin.wxacode.get({
        path: 'page/index/index',
        width: 430
      })
    return result
  } catch (err) {
    return err
  }
}

wxacode.getUnlimited

获取小程序码，适用于需要的码数量极多的业务场景。通过该接口生成的应用码，永久有效，数量暂无限制。

入参说明

返回值说明

包含二进制数据及其数据类型的对象

使用示例

exports.main = async (event, context) => {
  try {
    const result = await openapiWeixin.wxacode.getUnlimited({
        path: 'page/index/index',
        width: 430
      })
    return result
  } catch (err) {
    return err
  }
}

图像处理

img.aiCrop

入参说明

img 的结构

返回值说明

使用示例

openapiWeixin.img.aiCrop({
    img: {
      contentType: 'image/png',
      value: Buffer
    }
})

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
   "results": [ //智能裁剪结果
   {
       "cropLeft": 112,
       "cropTop": 0,
       "cropRight": 839,
       "cropBottom": 727
   },
   {
       "cropLeft": 0,
       "cropTop": 205,
       "cropRight": 965,
       "cropBottom": 615
   }
   ],
   "imgSize": { //图片大小
       "w": 966,
       "h": 728
   }
}

img.scanQRCode

入参说明

img 的结构

返回值说明

注意事项

• 文件大小限制：小于2M
• 支持条码、二维码、DataMatrix和PDF417的识别。 二维码、DataMatrix会返回位置坐标，条码和PDF417暂不返回位置坐标。

使用示例

exports.main = async (event, context) => {
    const result = await openapiWeixin.img.scanQRCode({
        img: {
            contentType: 'image/png',
            value: Buffer
        }
    })
}

返回数据示例

{
    "errCode": 0,
    "errMsg": "ok",
    "codeResults": [
        {
            "typeName": "QR_CODE",
            "data": "http://www.qq.com",
            "pos": {
                "leftTop": {
                    "x": 585,
                    "y": 378
                },
                "rightTop": {
                    "x": 828,
                    "y": 378
                },
                "rightBottom": {
                    "x": 828,
                    "y": 618
                },
                "leftBottom": {
                    "x": 585,
                    "y": 618
                }
            }
        },
        {
            "typeName": "QR_CODE",
            "data": "https://mp.weixin.qq.com",
            "pos": {
                "leftTop": {
                    "x": 185,
                    "y": 142
                },
                "rightTop": {
                    "x": 396,
                    "y": 142
                },
                "rightBottom": {
                    "x": 396,
                    "y": 353
                },
                "leftBottom": {
                    "x": 185,
                    "y": 353
                }
            }
        },
        {
            "typeName": "EAN_13",
            "data": "5906789678957"
        },
        {
            "typeName": "CODE_128",
            "data": "50090500019191"
        }
    ],
    "imgSize": {
        "w": 1000,
        "h": 900
    }
}

img.superresolution

入参说明

img 的结构

返回值说明

注意事项

• 文件大小限制：小于2M 图片支持使用img参数实时上传，也支持使用imgUrl参数传送图片地址，由微信后台下载图片进行识别。 目前支持将图片超分辨率高清化2倍，即生成图片分辨率为原图2倍大小

使用示例

exports.main = async (event, context) => {
    const result = await openapiWeixin.img.superresolution({
        img: {
            contentType: 'image/png',
            value: Buffer
        }
    })
}

返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "mediaId": "6WXsIXkG7lXuDLspD9xfm5dsvHzb0EFl0li6ySxi92ap8Vl3zZoD9DpOyNudeJGB"
}