HTTP请求
更新时间:
复制为 MD 格式
HTTP请求节点是创建API服务的开始节点,通过该节点可配置API的请求参数和SDK调用时的Action。每个API有且仅有一个HTTP请求节点,中间逻辑节点可根据业务需要选择其他功能节点,但必须以HTTP返回节点作为终止节点。开发的API可被外部调用,也可用于Web可视化开发。
前提条件
已完成业务服务的创建。详细内容请参见创建业务服务。
节点配置
在业务逻辑开发编辑页面的列表中,拖拽HTTP请求节点到中间画布并进行配置。
| 配置项 | 说明 |
| 节点名称 | 支持中文汉字、英文字母、数字和下划线(_)。长度不超过30个字符。 |
| Action | 设置调用API时,参数Action的值。可包含英文大小写字母和数字。 |
| 账号鉴权 | 选中后,开启账号鉴权。只有登录账号后才能调用该服务,且需要与IoT Studio的Web可视化应用配合使用。有关账号的详细内容,请参见账号鉴权。 |
| 访问限制 | 选中后,需要管理员在运营后台配置可调用该服务的角色,详细内容,请参见账号。 |
| 入参配置 | 根据业务需要,设置调用API的请求参数。单击+添加入参,参数设置包含:
|
节点输出
调用成功时的输出数据格式示例如下。
{
"code": 200,
"data": {
"入参名1": 参数值1,
"入参名2": 参数值2
},
"message": "success",
"localizedMsg": "成功"
}
调用失败的输出数据,请查看节点日志。
该节点输出数据的使用方法
配置后续节点时,可通过以下方式调用输出数据中某字段的值来使用。
- 以query方式调用具体的参数字段。
例如脚本节点或钉钉机器人节点,编辑内容时,可使用
query.入参名结构调用API的入参值。- 钉钉机器人:选择自定义配置方法,消息类型为text,内容配置示例为
"content": "{{query.cardId}}签到,已签到人数为{{payload.calcul_result}}"。 - 脚本节点:在脚本中通过
query.入参名引用入参值进行数据处理,例如for(let i=0;i,其中 query.column引用了入参column的值。
- 钉钉机器人:选择自定义配置方法,消息类型为text,内容配置示例为
- 将本节点选择为后续节点输入源。
例如条件判断或路径选择节点,选择数据源为HTTP请求中的某个请求参数。
在选择数据源对话框中,选择来自节点页签,从下拉列表中依次选择HTTP请求节点和对应的入参(如num),单击确定。
API调用方法
发布HTTP业务服务后,在业务逻辑开发工作台,单击左侧导航栏的服务调用设置按钮
。根据实际需求在API调用方式页签的请求示例中,获取调用方法。
说明 您可单击域名管理页签,根据页面提示自定义API的访问域名。
IoTApiClientBuilderParams builderParams = new IoTApiClientBuilderParams();
SyncApiGetClient syncClient = new SyncApiGetClient(builderParams);
Map<String, String> headers = new HashMap<>(8);
Map<String, String> querys = new HashMap<>(8);
// 设置api的版本
querys.put("apiVer", "1.0.0");
querys.put("id", UUID.randomUUID().toString());
// 如果需要登陆,设置当前的会话的token
querys.put("iotToken", "XXXXXXXXXX");
// 设置参数
querys.put("action", "xxx");
// 请求参数域名、path、request
String host = "xxx";
String path = "/xxx";
ApiResponse response = syncClient.doGet(host, path, true, headers, querys);
System.out.println(
"response code = " + response.getCode() + " response content = " + new String(response.getBody(),
"utf-8"));
该文章对您有帮助吗?