---
order: 47
navTitle: 调用WebAPI
---
# SuperPage交互-调用WebAPI

**调用WebAPI**交互可以调用后端嵌入式脚本，用于对表单或SuperPage页面进行后端的个性化业务处理。如图点击执行调度计划按钮后，立即执行调度计划：

![执行调度计划](./images/2022-11-24-14-56-12.gif)
示例地址：[执行调度计划](https://demo.succbi.com/v5/DEMO/app/script-demo.app?id=%E6%89%A7%E8%A1%8C%E8%B0%83%E5%BA%A6%E8%AE%A1%E5%88%92)

## 使用调用WebAPI{#use}

**调用WebAPI**交互可以通过资源路径调用任意`.action`的文件，以调用`custom.action`中`runScheduleOrETL`方法实现执行调度计划的功能为例，具体操作步骤如下：
![使用调用WebAPI](./images/2022-11-24-16-26-10.gif)

1. **添加交互**：选择**执行调度计划**按钮，添加**调用WebAPI**交互
2. **配置交互相关属性**：**API地址**中输入`/DEMO/app/script-demo.app/custom.action?method=runScheduleOrETL`，**参数**属性中**参数名称**设置为`mode`，**参数值**设置为`schedule`。更多参考[设置参数](#param)

## 设置参数{#param}

当后端脚本需要前端页面传递参数时，可在**调用WebAPI**交互中定义多个参数。而后端脚本方法中提供了自定义参数`params`来接收，该参数是一个json对象，通过`params.参数名`的方式（该参数名，是在交互中定义的参数）可以获取页面传递的参数内容。相关使用可参考下图中的注释部分。
![](./images/2022-11-28-09-32-10.png)

## 返回内容设置{#return}

后端脚本在执行完成后会有返回内容，当需要接收脚本处理后的返回内容时，可以勾选**将返回内容设置给参数**选项，并在**参数**下拉框中指定参数来接收返回内容。此处下拉框可供选择的参数来源于定义的[全局参数](../../../../data-viz/dash/design/data/param.md)，需要提前设置。
![将返回内容设置给参数](./images/2022-11-24-17-21-10.gif)

## 提示信息设置{#tooltips}

### 调用前提示{#before}

- **调用前显示确认对话框**：交互执行前，弹出对话框提示是否确认

![](./images/2022-11-24-13-50.png)

### 调用后提示{#after}

- **成功后关闭对话框**：默认勾选，调用WebAPI成功后，关闭所在对话框，若没有打开对话框，则无效果
- **成功后显示提示**：调用WebAPI成功后，顶部显示自定义的文字内容
- **失败后显示提示**：调用WebAPI失败后，顶部显示自定义的文字内容

顶部的提示消息框会在页面中停留3秒再隐藏，若希望更多的自定义设置，可以使用[显示消息框](./show-message.md)交互。