Appearance
超享汇开放 API · 渠道接入指南
本站为渠道商户对外发布的开放 API 文档,直接以 HTTP 调用对接。
业务模式简介
超享汇(CXH) 是面向渠道的权益分销与周期订阅平台:
- 渠道接入后,可在 CXH 商品池中选择已授权的 SPU(权益包)对外销售
- 用户购买后形成周期订阅(月度或日度,共 N 期),CXH 按期发放对应权益(视频会员、充电卡、加油卡等)
- 用户可在订阅完结前的任意时刻进入 H5 兑换页核销权益
订阅的清结算分为两种模式,渠道在 订阅下单 时通过 settlementMode 显式选定:
| 模式 | 标识 | 收款方 | 订阅 / 权益时机 |
|---|---|---|---|
| A · CXH 代扣 | CXH_DEDUCT | CXH 调用支付通道扣款(用户在 CXH 绑卡或渠道共享支付协议) | 扣款成功后计费,首扣 SUCCESS 后发放权益 |
| B · 渠道收单 | CHANNEL_COLLECT | 渠道自有支付体系收款(CXH 不参与) | 下单即开账、即时发放权益,退款由渠道自管 |
详细规则与状态机参见 订阅下单;两种模式可在同一渠道并存(不同 SPU 适用不同模式)。
公证服务(独立板块)
除订阅+权益外,CXH 还面向渠道开放公证服务(单次出证型业务,详见 公证服务接入指南):
- 渠道传入主体信息 + 公证收费,CXH 完成公证履约,回传公证订单号与公证函(PDF)
- 采用
CXH_DEDUCT模式(cxh 调用支付通道向用户扣款,公证收费notaryFeeCent即扣款金额);用户先通过订阅业务绑卡流程在 cxh 完成绑卡,公证下单时传bindOrderNo - 不走 SPU/SKU/类目,不形成周期订阅
- 同一渠道可同时接入订阅+权益与公证两套业务,凭据共享(
appId/appSecret/aesKey/callbackSecret)
文档中的角色定义
下表为各接口与流程图共用的角色定义:
| 角色 | 简写 | 说明 |
|---|---|---|
| 用户 | U | 终端消费者,在渠道侧购买订阅、兑换权益 |
| 渠道 | CH | 接入 CXH 开放 API 的商户;本文档的读者即渠道方研发与 BD |
| CXH | CXH | 超享汇开放平台,本文档所描述接口与 webhook 的提供方 |
| 支付通道 | P | A 模式下 CXH 合作的代扣支付机构(如银行直连或第三方代扣);仅 A 模式涉及 |
| 渠道支付 | — | B 模式下渠道自管的支付体系(CXH 不感知,流程图中通常归入"渠道"角色) |
| BD | — | CXH 商务对接人,负责开户、授权 SPU、配置支付通道与协助合同事宜,是对外接入的统一入口 |
文档导航
| 文档 | 用途 |
|---|---|
| 快速接入 | 接入流程总览,A/B 两模式角色交互图,从获取凭据到首次调用成功 |
| HTTP 请求 / 响应规范 | URL / 方法 / 头部 / 字段类型 / 状态码 / 重试与超时 |
| 签名 + 字段加密 | HMAC-SHA256 签名规则与 AES-256-CBC 字段加密详解 |
| API 接口 | 按模块分类的全部接口(商品 / 绑卡 / 订阅 / 解约 / 查询 / 回调) |
| 公证服务 | 公证业务独立板块:单次出证 / cxh 代扣 |
| FAQ | 常见接入问题 |
| 字段约定 | 状态枚举(主订单与子订单两层分离)、命名规范、周期日期推进规则 |
| 错误码 | 错误码总表与处理建议(含公证段) |
申请沙箱凭据
- 联系 BD 提供:公司全称、联系人、联系方式、业务场景
- CXH 完成开户后,一次性下发:
appId/appSecret/aesKey/callbackSecret四件套 - 渠道侧 7 天内完成接入测试,联调验收(联系 BD)后申请生产凭据(沙箱与生产密钥两套独立,互不通用)
沙箱限制
- 接口与生产完全一致:同一套 open API,同一份签名 / 字段 / 状态机 / webhook 协议;沙箱接通后切生产无需修改渠道代码
- 沙箱使用预设响应,扣款 / 短信 / 权益履约不真实发生;沙箱可通过请求字段触发成功 / 失败 / 异步等分支用例,详见 快速接入 § 沙箱触发字段
- 限频较宽松(默认 600/min,生产按合同约定),便于压测
- IP 白名单可申请关闭(生产环境强制启用)
联系方式
- 接入对接:bd@cxh.me
- 技术答疑:tech@cxh.me(工作日 9:00-18:00)
- 紧急联络:7×24 短信告警(合同附录)