如何自定义知行之桥Webhook端口返回的Response消息

一、Webhook端口功能概述

知行之桥的Webhook端口提供灵活的消息响应机制,支持用户通过修改配置文件自定义返回的消息体内容,能够查看是否调用接口成功、数据是否推送成功以及自定义返回给用户端的响应内容。

本指南将详解如何通过脚本配置实现以下需求:

  • 设置JSON/XML等不同格式的响应消息
  • 自定义成功/失败时的返回内容

扩展阅读:Webhook端口使用介绍与演示

二、配置流程详解

创建好Webhook端口后,可以通过POST 方法访问webhook地址,可以看到返回结果的格式。本文以POSTMAN为例:

1. Webhook默认的返回消息

调用成功:

Webhook-response1.png

调用失败:

Webhook-response2.png

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

Webhook-response3.png

调用失败时,在知行之桥EDI系统中,Webhook端口的对应文件会显示Error,且文件内容为空。在其他详细信息页面中可以查看调用失败的错误原因提示:

Webhook-response4.png

2. 自定义返回消息

a. 修改返回的消息类型

比如需要返回JSON,可以直接在访问地址上加上?@json

Webhook-response5.png

b. 修改返回的消息内容

比如,成功时需要返回

需要按照以下步骤操作:

1) 首先直接在浏览器访问webhook地址

Webhook-response6.png

2)导出Webhook端口设置

鼠标右键点击Webhook端口,在弹窗中选择 导出端口设置

Webhook-response7.png

3)解压下载的文件,找到解压缩文件夹Public下的webhook.rsb文件进行编辑

Webhook-response8.png

4)完成后,将以下解压文件全部重新压缩为zip文件

Webhook-response9.png

5) 选择导入-》自定义导入-》替换所有冲突

Webhook-response10.png

导入文件的时候,如果没有找到ZIP文件可以将弹窗右下角的ARCFLOW文件(.arcflow)更改为 所有文件(.*),即可看到我们刚刚打包好的文件了。

Webhook-response11.png

工作区导入 弹窗中选择导入类型为:自定义导入,根据页面指示点击下一步

Webhook-response12.png

将会出现解决导入冲突页面,选择第二项,替换所有冲突,点击导入。

Webhook-response13.png

上传成功后可再次请求Webhook地址,请求成功后,Webhook端口返回的Response消息如下:

Webhook-response14.png

请求失败时,Webhook端口返回的Response消息如下:

Webhook-response15.png

如果您希望了解有关EDI对接的相关信息,欢迎联系我们。

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

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

标签: , , , , ,
文章分类 帮助文档, 常见问题和回答, 操作指南, 知识库