Webhook端口使用介绍与操作演示

Published On: 2025年10月21日Categories: 产品介绍, 帮助文档, 常见问题和回答, 操作指南, 知识库Views: 2

© All rights reserved. • 西安知行软件有限公司 • 陕ICP备09022277号

在很多 API 集成项目中,用户通过调用知行之桥的 API 接口向 EDI 系统推送数据时,经常会遇到几个常见问题:

  • 我怎么知道接口调用是否成功?
  • 数据有没有成功推送到知行之桥?
  • 推送之后,知行之桥会返回怎样的响应结果?

为了解决这些集成过程中的可视化反馈与状态确认问题,知行之桥提供了 Webhook 端口功能。
通过 Webhook,系统可以在每次接口调用或数据推送后,主动向用户端返回明确的响应信息,不仅能实时反馈调用结果,还可以根据用户需求,自定义返回的响应内容。

接下来,我将基于 知行之桥 EDI 系统 V2025,为大家演示 Webhook 端口的使用方式和典型应用场景。

一、Webhook端口功能介绍

在知行之桥中,Webhook 端口 允许外部系统通过 HTTP POST 或 PUT 请求,将数据直接发送到知行之桥的工作流中。

每个 Webhook 端口都对应一个对外公开的访问端点,外部客户端可以向该端点提交 XML 或 JSON 格式的数据文件。

这些文件会自动写入端口的输出区域,并继续传递给工作流中已连接的后续端口,实现数据的自动接收与处理。

1.认证

在Webhook端口,可以授权用户使用身份验证令牌访问 API 资源,提供 HTTP 身份验证中的身份验证令牌,如下所示。

KAV2025_WebhookPort1.png

点击“添加”,勾选启用POST、PUT权限。

KAV2025_WebhookPort2.png

身份验证令牌(Authtoken)”需要在添加用户时妥善保管,出于安全考虑,这是身份认证令牌(Authtoken)最后一次明文。保存此新用户之前,请将此授权令牌复制到安全的地方。如果授权令牌丢失,可以随时为该用户创建一个新的。

在知行之桥EDI系统V2025中,支持自定义每小时最大请求数以及最大并发请求数,默认无限制请求。

以上信息配置完成后,点击右下角的“保存变更”。在 用户 页面即可看到新创建的用户Iris。

KAV2025_WebhookPort3.png

2.服务器

在Webhook端口的“服务器”页面,点击“+添加”,添加受信任的IP地址,使用“*”表示允许任何 IP 地址访问。

KAV2025_WebhookPort4.png

二、使用Postman调用实例

在“工作流”页面搜索并创建 Webhook 端口。

KAV2025_WebhookPort5.png

在Webhook端口的“设置”页面,显示有Webhook端口URL,将其复制到Postman中。

KAV2025_WebhookPort6.png

选择PUT或POST方法,在“Headers”中添加属性“x-CData-authtoken”,值为添加用户时保存好的身份验证令牌,以及属性“Content-Type”,值为“application/xml”。

KAV2025_WebhookPort7.png

在“Body”中,选择“raw”,再选择主体数据的格式,示例中是XML格式。用户可将要发送给交易伙伴的业务数据直接写入该请求主体中,示例如下。

KAV2025_WebhookPort8.png

之后点击Send,发送之后可以去知行之桥的Webhook端口的输出页面查看,无论调用成功与否,在该页面都会显示相应的信息。

KAV2025_WebhookPort9.png

调用失败时,文件会显示Error,且文件内容为空。下载消息日志,可以查看到调用失败的错误原因提示:

KAV2025_WebhookPort10.png

日志中的报错提示与POSTMAN中显示的相同。

KAV2025_WebhookPort11.png

调用成功时,文件会显示Success,点击文件名即可预览文件,点击“下载消息”,下载文件,文件内容便是在Postman调用时,请求的主体内容,用户便实现了成功将业务数据推送至EDI系统的操作。

KAV2025_WebhookPort12.png

下载消息日志,也可以查看到调用成功的提示。

KAV2025_WebhookPort13.png

三、自定义响应

除了上述的调用方式,也可以通过使用响应(Response)事件来自定义响应,以满足用户的自定义需求。指定时,端口期望通过 _response 提供自定义响应。 例如,将传入请求的参数通过消息头部进行显示,并沿工作流向下传递。可在Webhook端口的“事件”页面的“响应(Response)”栏中编写脚本如下:




KAV2025_WebhookPort14.png

其中,MyWebhookHeader不仅会显示为Webhook端口接收到的消息头部参数,还会作为用户调用成功之后收到响应中的自定义标识信息。

在Postman中调用时填写Headers信息如下,将MyWebhookHeader的自定义值填入其中:

KAV2025_WebhookPort15.png

调用成功,得到的响应便如下所示:

KAV2025_WebhookPort16.png

Webhook端口接收到的消息头部会显示MyWebhookHeader及其值:

KAV2025_WebhookPort17.png

该消息头部会随着消息流入工作流中,Webhook端口之后所连接的端口都可引用该参数。

了解更多 EDI 信息,请参阅: EDI 是什么?

了解更多EDI信息,请您通过邮件 sales@kasoftware.cn 联系我们。点击下方蓝色按钮,即可免费试用EDI软件。

注:文案部分图片及内容来源于网络,版权归原创作者所有,如有侵犯到您的权益,请您联系我们进行删除,给您带来困扰,我们深感抱歉。

为什么选择

知行之桥®?​

根据企业规模与集成需求,提供从本地部署到云端托管的灵活选择

可视化 EDI 工作流

基于拖拽式图形化设计器,零代码构建完整 EDI 业务流程,满足复杂供应链自动化场景。

Odette & Drummond 认证

通过 Odette(OFTP) 与 Drummond(AS2) 权威认证,确保与主机厂安全合规、高可靠的数据交换。

多系统集成能力

提供数据库、REST/SOAP、FTP/SFTP 等标准化接口,实现 ERP、WMS、MES 等系统的双向数据自动同步。

数据映射格式转换

内置可视化 Mapping 编辑器,零代码实现 EDI 报文与企业内部数据格式(XML/JSON…)的映射转换及复杂规则处理。

实时监控预警机制

全流程可视化监控报文状态,支持邮件、钉钉、企业微信自动预警,保障 JIT 交付的稳定性与及时性。

多工厂支持

支持集团级多组织、多工厂架构,实现数据隔离与权限管控,统一平台集中运维,满足大型制造企业多地点协同需求。