惠客宝
    惠客宝
    • 接入说明
    • 结算相关
      • 结算查询
        POST
      • 结算申请
        POST
      • 结算订单通知
        POST
      • 结算详情回单查询
        POST
    • 数据模型
      • 订单状态
      • 账户类型

    接入说明

    1. 特别说明#

    在未得到书面许可的情况下,不得以任何形式复制或传播本文档的内容。

    2. 文档说明#

    此文档为合作客户的产品及技术人员提供参考。

    3. 接口调用规范#

    3.1 环境网关地址#

    • 测试环境:https://xxxxxx/gst-api
    • 生产环境:https://xxxxxx/gst-api

    3.2 协议规则#

    • 传输方式:采用 HTTPS 传输
    • 提交方式:采用 POST 方法提交
    • 数据结构:JSON
    • 字符编码:采用 UTF-8 字符编码

    3.3 签名规则#

    签名算法:SHA256WithRSA#

    签名验签步骤(data 加密[RAS+AES]):#

    签名加密步骤
    1. 使用 AES 加密算法对 body 参数进行加密
      1. AES 密钥长度约定为 128 位
      2. AES/ECB/PKCS5Padding 填充模式
      3. body 加密后,转成 base64后参与加签
    2. 使用 RSA 算法对 AES 的密钥进行 趣工宝公钥加密
      1. AES key 转换成 16 进制之后,用 rsa 公钥加密
    3. 使用 RSA 客户私钥对参数签名后传输,
      1. 将请求应答报文集合 M 排除字段值为空或 null的字段,按照属性名字母顺序,即按 ASCII 码从小到大排序(字典序);
      2. 使用 URL 键值对的格式(即 key1=value1&key2=value2…)拼接成字符串;
      3. 数据集合中的 signValue 属性和 signType 属性均不参与签名,需要剔除之后进行字段拼接;
      4. 对拼接的字符串做一次MD5 摘要。
      5. 使用客户RSA 私钥对 MD5 字符串加签。(生成签名)

    请求示例#

    {"appId": "108120200417114401","body": "rmgDGXwIwzYD4eCVPHkMsC3X4CO4WOZpeDTqSr6SCMSf3+s8FVlL9I8A3yIzWxF9","encKey": "42F8F53E504930D5B49XXXXXXXXXXX","reqNo": "da96f063a7f64866bdb71df9e9f9d27f","signType": "SHA256WithRSA","signValue": "AH0PYv3eFgqqle+jByFj6VWU8X7yuXXXXXXXX","timestamp": "2024-01-30 10:28:29","v": "2.0"}
    验签解密步骤:
    1. 使用趣工宝RSA公钥进行验签
    2. 取出加密AES密钥(encKey)用客户RSA私钥使用 RSA 算法进行解密
    3. 使用AES解密算法对body参数进行解密

    3.5 接口数据规则#

    符号说明#

    符号
    含义
    Y
    必须填写的域
    N
    非必须填写的域
    O
    条件选填

    请求参数数据结构#

    参数名称
    参数含义
    数据类型
    必填
    参数说明
    appId
    appId
    String
    Y

    reqNo
    客户请求流水号
    String(50)
    Y

    timestamp
    当前请求时间
    String
    Y
    格式:yyyy-MM-dd HH:mm:ss
    v
    接口版本
    String
    Y
    1.0
    body
    业务参数
    String
    Y
    json 字符串,根据具体接口规范填写
    encKey
    加密 key
    String
    N
    使用 rsa 加密的 key 密文
    signType
    签名方式
    String
    Y
    SHA256WithRSA
    signValue
    签名值
    String
    Y
    参见签名规则

    返回参数数据结构#

    参数名称
    参数含义
    数据类型
    必填
    参数说明
    body
    业务参数
    String
    N
    json 字符串,根据具体接口规范返回
    code
    返回码
    String
    Y

    msg
    返回信息
    String
    Y

    reqNo
    客户请求流水号
    String
    Y
    原请求流水号
    signType
    签名方式签名方式
    String
    Y

    signValue
    签名值
    String
    Y

    修改于 2025-12-31 03:19:47
    下一页
    结算查询
    Built with