1. iPaaS API列表
iPaaS API
  • iPaaS API列表
    • 接入指南
    • 快速调试指南
    • 签名工具
    • 储值通
      • 储值卡充值
      • 查询储值卡充值结果
      • 查询储值卡退款结果
      • 储值卡支付
      • 查询储值卡支付结果
      • 查询可用储值卡列表
      • 储值卡退款
      • 储值调账
      • 查询储值卡
    • 导购通
      • 更新导购档案
      • 查询导购档案
      • 变更导购专属关系
    • 试用单通
      • 更新试用单发货状态
    • 积分通
      • 增加积分
      • 冻结积分
      • 回补积分
      • 消耗积分
      • 解冻积分
      • 查询积分
      • 减少积分
      • 查询积分日志
    • 会员通
      • 修改会员归属门店 Copy
      • 更新会员
      • 解密会员信息
      • 创建加密会员
      • 换绑会员手机号
      • 换绑加密会员
      • 查询会员
      • 创建会员
      • 修改会员归属门店
      • 注销会员
      • 修改会员禁用名单
      • 更新加密会员
      • 解密加密会员
      • 减少成长值
      • 查询成长值
      • 增加成长值
      • 更新等级
    • 标签通
      • 删除标签组
      • 更新标签组
      • 更新会员标签
      • 查询会员标签
      • 创建标签组
    • 订单通
      • 更新订单同城配送状态
      • 更新订单自提状态
      • 同步聚合外部订单
      • 查询订单详情
      • 同意退款单
      • 外部订单换货
      • 外部订单非等价换货
      • 创建外部订单
      • 更新订单发货状态
      • 查询订单同城配送状态
      • 外部订单退货
      • 拒绝退款单
      • 创建主动退款
    • 店铺通
      • 关闭门店
      • 修改门店
      • 修改自提点
      • 创建自提点
      • 更换门店
      • 关闭自提点
      • 创建门店
    • 权益卡通
      • 同步会员权益卡
      • 调整会员权益卡有效期
      • 删除会员权益卡
    • 商品通
      • 更新商品上下架状态
      • 更新商品分组
      • 查询商品分组
      • 同步商品信息
      • 删除商品分组
      • 创建商品分组
      • 同步商品信息(独立)
      • 更新商品价格
    • 电子卡券通
      • 核销电子卡券
    • 库存通
      • 已过时
        • 同步商品库存(已过时)
      • 同步商品库存
    • 优惠券通
      • 单通以有赞为准
        • 查询优惠券详情
        • 查询优惠券列表
        • 查询可用优惠券列表
        • 查询优惠券折扣
        • 发放优惠券
        • 核销优惠券
        • 退还优惠券
        • 转赠优惠券
        • 回收优惠券
      • 双通以三方为准
        • 发放优惠券
        • 核销优惠券
        • 退还优惠券
        • 转赠优惠券
        • 回收优惠券
        • 禁用优惠券
      • 已过时
        • 转赠优惠券(已过时)
        • 核销后退还优惠券(已过时)
        • 核销有赞优惠券(已过时)
        • 预核销优惠券(已过时)
        • 解冻优惠券(已过时)
        • 发放优惠券(已过时)
        • 冻结优惠券(已过时)
      • 创建优惠券模板
      • 更新优惠券模板
      • 失效优惠券模板
      • 删除优惠券模板
    • 设置环境变量
      POST
  1. iPaaS API列表

接入指南

有赞iPaaS接口接入指南#

1. 准备工作#

1.1 环境要求#

JDK版本要求:1.8及以上

1.2 获取必要参数#

调用前需要准备以下参数:
host: iPaaS应用的对外请求域名(区分开发和生产环境)
app-id: 系统打通标识ID(格式:{{有赞商城总店ID}}_{{厂商连接器的英文名}})
privateKey: 私钥(用于接口调用签名)
获取方式请参考下图指导(可在集成方案页面获取到对应信息):
图片

2. 项目配置#

2.1 最新版本#

当前最新版本: 2.7.16-RELEASE
版本更新: 版本号会持续更新,请关注官方发布

2.2 Maven依赖配置#

推荐使用dependencyManagement管理版本:
<properties>
    <cloud-connector-sdk.version>2.6.69-RELEASE</cloud-connector-sdk.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.youzan</groupId>
            <artifactId>cloud-connector-sdk-dependencies</artifactId>
            <version>${cloud-connector-sdk.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>3.12.0</version>
    </dependency>
</dependencies>

2.3 直接下载JAR包#

如不想使用Maven,可直接下载JAR包:
https://maven.youzanyun.com/#browse/browse:maven-releases:com%2Fyouzan%2Fcloud-connector-sdk-client%2F${cloud-connector-sdk.version}%2Fcloud-connector-sdk-client-${cloud-connector-sdk.version}.jar
注:请将连接中${cloud-connector-sdk.version}替换为具体的版本,如:2.7.16-RELEASE

3. 接口调用规范#

3.1 请求格式#

接口路径: /open/gateway/{接口名}/{版本号}
请求方法: POST
Content-Type: application/json

3.2 公共请求头参数#

参数名必填说明
app-id是系统打通标识ID
ts是请求时间戳(毫秒),过期请求会被拦截
nonce是请求随机串
sign-type是加签算法类型,目前仅支持RSA
sign是签名结果

3.3 签名算法#

1.
收集所有Header中的公共参数
2.
按照key的字母顺序排序
3.
拼接成字符串
4.
使用RSA私钥进行签名
5.
具体实现参考:com.youzan.cloud.connector.sdk.client.utils.YzCloudSignature#rsaSign

4. 完整调用示例#

5. 注意事项#

1.
密钥安全: 请妥善保管私钥,不要泄露给第三方
2.
时间戳: 确保服务器时间准确,避免因时间差导致签名验证失败
3.
随机串: 每次请求应使用不同的nonce值,防止重放攻击
4.
错误处理: 建议添加完善的错误处理机制,对网络异常、签名验证失败等情况进行处理

6. 常见问题#

6.1 签名验证失败怎么办?#

检查私钥是否正确
确认时间戳是否在有效期内
验证参数拼接和签名算法是否正确
检查请求头参数是否完整

6.2 如何升级SDK版本?#

更新properties中的版本号:
<cloud-connector-sdk.version>新版本号</cloud-connector-sdk.version>

📞 技术支持: 如遇到问题,请联系iPaaS技术支持团队获取帮助。
修改于 2025-09-26 04:48:34
下一页
快速调试指南
Built with