自定义 API

小程序支持自定义 API，若已有小程序 API 不能满足您的需求，您可以自行扩展。小程序 API 复用 H5 容器的 JSAPI 插件机制，这意味着您可以按照 H5 容器提供的插件机制来扩展 API，并且小程序可以直接调用您已经写好的自定义 API。

自定义 API

请参考 H5 容器的自定义 JSAPI 的文档来自定义 API：

说明：小程序自定义 API 仅支持从页面调用 native，但不支持 native 向页面主动发送事件。

在小程序中调用 API

在小程序中使用如下方法来调用自定义的 API：

  1. my.call(API, param, callback)

其中，

  • API：自定义 API 的名称。
  • param：调用 API 的参数。
  • callback：API 执行的回调方法。

以调用 rpc 方法为例，调用示例代码如下：

  1.     my.call('rpc', {
  2.       operationType: 'com.test.mb1001',
  3.       requestData: [{
  4.         tranCode: 'MB1001',
  5.         customerType: 0,
  6.         customerId: 0,
  7.         UnitType: '7A238BD3-A90B-4458-885E-129230BCF7F1',
  8.         sessionId: 'zzzzzzzzzzzzzzzz',
  9.         serverIP: 'zzzzzzzzzzzzzzzz',
  10.         mobileNo: username,
  11.         password,
  12.         optionFlag: 3,
  13.       }]
  14.     }, (res) => {
  15.         // do your business here.
  16.     })

您可以参考 H5 容器 JSAPI RPC 的文档来理解小程序和 H5 调用的异同。

取消注册自定义事件

如不再需要自定义事件，请参见 取消注册自定义事件。