使用和管理 API

最近更新时间:2026-03-24 14:05:32

我的收藏
本文将介绍如何管理和使用 API(开放服务)。

编辑 API

API 方法详情页面,单击右上角编辑 APIs 方法




重新授权 API

API 页面,若在状态列出现鉴权失败,则可以单击重新授权重新发起授权。
[](id:delete)

删除 API

API 列表页面,找到编辑的 API,在操作列单击更多 > 删除
注意:
API 删除前,必须解绑所有应用的关联使用。

使用 API

目前在应用编辑器、自定义数据模型和自定义 API 中,都可以使用 API,支持可视化和自定义代码两种方式。

通过组件行为调用

进入应用编辑器,在组件行为可以调用 API 方法,具体请参见 事件介绍

通过低代码编辑器调用

进入应用编辑器,可以在应用的 代码编辑器 及微搭组件的组件代码中使用。 示例代码:
export default async function({event, data}) {
const result = await $w.cloud.callDataSource({
name: 'API 标识',
methodName: '方法标识',
params: {}, // 方法入参
});
}


在自定义数据模型或自定义 API 中调用

在自定义数据模型和自定义 API 中通过自定义代码方式,可以调用其他 API,具体请参见 自定义代码(云函数)。 示例代码:
module.exports = async function (params, context) {
const result = await context.callConnector({
name: 'API 标识',
methodName: '方法标识',
params: {}, // 方法入参
});

return {
_id: '123456',
};
};

说明:
APIs 可能使用了固定出口 IP,请确认业务是否依赖该 IP 白名单配置,出口 IP 参考如下:
175.24.211.44
175.24.212.162
175.24.213.48
175.24.214.104
175.24.214.93
49.234.25.245
49.234.27.58
49.234.3.160
49.234.34.31
49.234.35.33