普元数据集成平台 普元数据集成平台
产品介绍
安装部署
快速入门
操作指南
FAQ
  • RestClient 示例
  • 准备数据
  • 新建批量作业
  • 画布中依次拖入生成记录图元、RestClient图元、JSON输入图元、写日志图元,如下图:
  • 配置"生成记录"组件属性
  • 配置"RestClient"组件属性
  • 配置"JSON输入"组件属性
  • 配置"写日志"组件属性
  • 通用配置
  • 保存草稿
  • 运行
  • 提交版本

# RestClient 示例

本示例主要介绍 RestClient 调用 API 的使用方法。

该场景通过 RestClient 调用查询快递信息。主要步骤如下:

  • 准备数据
  • 新建批量作业
  • 画布中拖入生成记录图元、RestClient图元、JSON输入图元、写日志图元
  • 配置"生成记录"组件属性
  • 配置"RestClient"组件属性
  • 配置"JSON输入"组件属性
  • 配置"写日志"组件属性
  • 通用配置
  • 保存草稿
  • 运行
  • 提交版本

# 准备数据

快递接口:http://www.kuaidi100.com/query?type=快递公司代号&postid=快递单号

例如:https://www.kuaidi100.com/query?type=shunfeng&postid=SF1693053866319

调用后的返回值如下:
{
    "message": "ok",
    "nu": "SF1693053866319",
    "ischeck": "0",
    "condition": "C00",
    "com": "shunfeng",
    "status": "200",
    "state": "0",
    "data": [
        {
            "time": "2024-01-22 00:03:36",
            "ftime": "2024-01-22 00:03:36",
            "context": "您的快件离开【乌鲁木齐转运中心】,已发往【新疆伊犁州伊宁市】",
            "location": "昌吉回族自治州,昌吉市"
        },
        {
            "time": "2024-01-21 17:38:12",
            "ftime": "2024-01-21 17:38:12",
            "context": "您的快件已经到达【乌鲁木齐转运中心】",
            "location": "昌吉回族自治州,昌吉市"
        },
        {
            "time": "2024-01-18 21:57:18",
            "ftime": "2024-01-18 21:57:18",
            "context": "您的快件离开【郑州转运中心】,已发往【乌鲁木齐转运中心】",
            "location": "郑州市,中原区"
        },
        {
            "time": "2024-01-18 21:37:57",
            "ftime": "2024-01-18 21:37:57",
            "context": "您的快件已经到达【郑州转运中心】",
            "location": "郑州市,中原区"
        },
        {
            "time": "2024-01-17 20:59:46",
            "ftime": "2024-01-17 20:59:46",
            "context": "您的快件离开【漯河转运中心】",
            "location": "漯河市,源汇区"
        },
        {
            "time": "2024-01-17 20:09:46",
            "ftime": "2024-01-17 20:09:46",
            "context": "您的快件已经到达【漯河转运中心】",
            "location": "漯河市,源汇区"
        },
        {
            "time": "2024-01-16 19:40:01",
            "ftime": "2024-01-16 19:40:01",
            "context": "您的快件被【河南省许昌市】揽收,揽收人: 王培霞(15893793903)",
            "location": "许昌市,魏都区"
        }
    ]
}

ps:快递公司编码:申通=”shentong” EMS=”ems” 顺丰=”shunfeng” 圆通=”yuantong” 中通=”zhongtong” 韵达=”yunda” 天天=”tiantian” 汇通=”huitongkuaidi” 全峰=”quanfengkuaidi” 德邦=”debangwuliu” 宅急送=”zhaijisong”

# 新建批量作业

点击资源树节点上的【...】,选择弹出菜单【新建批量作业】。填写作业名称、选择作业类型"离线转换"。

RestClient

# 画布中依次拖入生成记录图元、RestClient图元、JSON输入图元、写日志图元,如下图:

RestClient

# 配置"生成记录"组件属性

api_url的值为:https://www.kuaidi100.com/query?type=shunfeng&postid=SF1693053866319

method的值为:GET

content-type的值为:application/json

RestClient

# 配置"RestClient"组件属性

在"RestClient"图元上右键,点击【编辑】按钮,弹出"RestClient"组件的弹窗。配置项如下图:

RestClient

注:认证、代理、请求头、参数,该示例无需配置,用户可以按需配置。

# 配置"JSON输入"组件属性

在"JSON输入"图元上右键,点击【编辑】按钮,弹出"JSON输入"组件的弹窗。配置项如下图:

RestClient

RestClient

取字段路径的写法: $..time 或 $.data..time $..context 或 $.data..context

属性设置完毕请点击【确定】按钮。

# 配置"写日志"组件属性

在"写日志"图元上右键,点击【编辑】按钮,弹出"写日志"组件的弹窗。配置项如下图:

RestClient

属性设置完毕请点击【确定】按钮。

# 通用配置

在通用配置中可以配置任务优先级、Worker 分组、命名参数、本地参数、超时告警。

可以参考示例关系型表数据同步示例 中的"通用配置"说明。

# 保存草稿

如果所有组件属性都已设置完毕,点击【保存】按钮,可以看到保存过的历史草稿,并可以随意切换草稿。(草稿只保存最近 10 个)

可以参考示例关系型表数据同步示例 中的"保存草稿"说明。

# 运行

点击【运行】按钮,可以运行已经开发完毕的场景,在日志栏可以看运行日志及运行结果。

RestClient

# 提交版本

当草稿运行正常后,点击【提交】按钮可以将该版本提交到作业调度,每次修改提交都会生成新的版本,可以看到提交的历史版本,并可以随意切换版本。

提交后的版本,可以在作业调度中进行"定时"调度配置。

可以参考示例关系型表数据同步示例 中的"提交版本"说明。

← 合并记录示例 数据脱敏示例 →