首页 / 使用 / 文档中心

文档中心

最后更新:2026 年 9 月 2 日

文档中心是开发者的工具箱。所有接口基于 HTTPS + JSON,采用 AppKey / AppSecret 签名认证,数据写入区块链账本后不可篡改、全程可追溯。

快速入门指南

三步跑通第一个接口:

第一步:注册开发者账户

在 CCPP 开放平台注册开发者账户,完成企业或个人实名认证。

第二步:创建应用,获取密钥

创建应用后获得 appKey 与 appSecret。appSecret 仅用于服务端签名,切勿写入前端代码或泄露。

第三步:获取访问令牌

curl -X POST https://open.ccpp.fund/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "appKey": "ak_xxxxxxxx",
    "timestamp": 1700000000,
    "sign": "HMAC-SHA256(appSecret, appKey+timestamp)"
  }'

返回的 accessToken 有效期为 2 小时,调用业务接口时置于请求头 Authorization: Bearer <token>。

API 参考

1. 获取访问令牌

方法路径说明
POST/api/v1/auth/token用 appKey + 签名换取访问令牌

请求参数

参数类型必填说明
appKeystring是应用标识
timestamplong是秒级时间戳
signstring是HMAC-SHA256 签名

返回示例

{
  "code": 0,
  "msg": "success",
  "data": { "accessToken": "at_xxxxxxxx", "expiresIn": 7200 }
}

2. 消费返利清分

商户完成一笔消费后上报返利,由清分系统「清源」计算并写入区块链账本。

方法路径说明
POST/api/v1/clearing/rebate上报一笔消费返利

请求参数

参数类型必填说明
orderIdstring是商户订单号,幂等去重
userIdstring是消费者唯一标识(脱敏)
amountstring是消费金额,单位分
rebateRatestring是返利比例,如 0.005

返回示例

{
  "code": 0,
  "data": {
    "clearingId": "cl_xxxxxxxx",
    "txHash": "0x3f8a...c2e1",
    "blockHeight": 8823104
  }
}

3. 区块链记账查询

方法路径说明
GET/api/v1/ledger/records按条件查询链上记账记录

查询参数

参数类型必填说明
userIdstring是消费者唯一标识
pageint否页码,默认 1
pageSizeint否每页条数,默认 20

4. 养老金权益查询

方法路径说明
GET/api/v1/pension/balance查询累计养老金权益

返回示例

{
  "code": 0,
  "data": {
    "totalRebate": "12893.55",
    "pensionRights": "13211.39",
    "compoundEarned": "317.84"
  }
}

开发教程

接入电商返利

以电商场景为例,完整接入分为四步:

  1. 下单回调:用户支付成功后,电商平台触发返利上报;
  2. 签名上报:服务端对订单参数做 HMAC 签名,调用返利清分接口;
  3. 链上确认:清分系统计算返利并写入区块链,返回 txHash;
  4. 权益累积:返利资金划入商业银行监管账户,用户养老金权益自动累积。

关键点是:返利资金不经电商平台,也不经 CCPP 平台,而是直接进入受监管账户——这是 CCPP 与普通返利平台的根本区别。

建议先读快速入门,再按需查阅 API 参考,遇到具体场景时对照教程实践。