有赞iPaaS接口快速调试指南

🎯 调试概述

在进行正式开发前，您可以通过Apifox快速调试接口，验证接口功能和返回结果是否符合预期，无需编写任何代码。

📋 环境准备

1. 安装Apifox客户端

下载地址: https://docs.apifox.com/download

支持平台: Windows、macOS、Linux

2. 加入iPaaS接口项目

加入方式: 点击下方邀请链接加入项目

项目权限: 仅支持邀请制，确保接口文档的安全性

加入iPaaS API项目

⚠️ 注意: 邀请链接7天后(2026-03-05)过期，如过期请联系技术支持重新获取。

3. 获取调试参数

调试前需要准备以下关键参数：

参数名	说明	获取位置
host	iPaaS应用对外域名	开发者控制台 -> 集成方案详情
app-id	系统打通标识ID	开发者控制台 -> 集成方案详情
privateKey	接口调用私钥	开发者控制台 -> 集成方案详情

获取方式: 登录有赞云开发者控制台，在对应应用的集成方案页面查看相关信息。

获取方式请参考下图指导（可在集成方案页面获取到对应信息）：

🔧 环境配置

支持的环境类型

环境名称	对应场景	说明
开发环境	开发者本地环境	本地部署调试
测试环境	ISV开发环境	云端部署测试
生产环境	ISV生产环境	正式环境使用

设置环境变量步骤

选择设置接口

在Apifox中找到「设置环境变量」接口

配置前置操作

进入「调试」页面

点击「前置操作」->「添加前置操作」->「自定义脚本」

配置环境变量

完成设置

点击「发送」按钮

404报错可忽略（仅用于设置环境变量）

如果是503报错，则表示服务不可用，如果是开发环境，可能是容器被回收了，需要重新构建发布一下后再进行接口调用。

 503 Service Temporarily Unavailable

💡 提示: 每个环境只需设置一次，后续该环境的所有接口调用都会自动使用这些参数。

🚀 接口调试

调试步骤

选择接口

在接口列表中选择要调试的接口（如：会员通查询会员接口）

在右上角选择对应的环境（开发/测试/生产）

配置鉴权

点击「调试」->「前置操作」

添加前置操作，选择「公共脚本」->「iPaaS 鉴权」

设置请求参数

在请求body中配置业务参数

可使用「自动生成」功能快速生成示例参数

替换必要字段为实际业务数据

发起请求

点击「发送」按钮

在响应区域查看返回结果

成功响应示例

状态码: 200

响应格式: JSON

返回内容: 业务数据或错误信息

⚠️ 注意事项

参数安全性

请勿将私钥泄露给第三方

环境隔离

不同环境的参数完全隔离

请确保使用对应环境的参数进行调试

请求限制

频繁请求可能触发限流

建议合理控制调试频率

数据保护

生产环境调试请使用测试数据

避免在生产环境进行破坏性操作

🆘 常见问题

Q1: 邀请链接过期怎么办？

A: 联系技术支持重新获取邀请链接。

Q2: 如何确认参数是否正确？

A: 检查返回的错误码和错误信息，通常会有明确的参数错误提示。

Q3: 接口返回签名失败？

A: 请确认privateKey是否正确，以及环境变量设置是否生效。

Q4: 如何切换调试环境？

A: 在接口右上角的环境选择器中切换对应环境即可。

📞 技术支持: 如遇到问题，请联系iPaaS技术支持团队获取帮助。

快速调试指南

有赞iPaaS接口快速调试指南#

🎯 调试概述#

📋 环境准备#

1. 安装Apifox客户端#

2. 加入iPaaS接口项目#

3. 获取调试参数#

🔧 环境配置#

支持的环境类型#

设置环境变量步骤#

🚀 接口调试#

调试步骤#

成功响应示例#

⚠️ 注意事项#

🆘 常见问题#

Q1: 邀请链接过期怎么办？#

Q2: 如何确认参数是否正确？#

Q3: 接口返回签名失败？#

Q4: 如何切换调试环境？#