调用接口

1、查询活动接口

使用场景： 业务在对接积分捐活动场景时，需要知道当前项目的活动相关信息，可以调用本接口来获取。

调用凭证： 应用签名

请求方式： POST（HTTPS）

请求地址： https://test-oapi.gongyi.qq.com/api/reward_donate_service/GetActivityInfo

请求参数：

注：同一个项目可能被绑定到多个活动上，所以该接口回包是一个数组，业务侧自行选择当前的活动。

• 请求示例

{
  "project_no": "224328"
}

返回参数：

返回示例：

{
  "code": 0,
  "msg": "Success",
  "op_time": 1650812345,
  "trace_id": "1a2b3c4d5e6f7g8h1a2b3c4d5e6f7g8h",
  "data": {
    "activity_no": "123",
    "activity_type": 2,
    "activity_name": "测试活动",
    "org_no": "110058",
    "activity_status": 2,
    "money": "500000",
    "merchant_no": "19680000001",
    "project_no_list": [
      "224328",
      "50000636"
    ]
  }
}

2、B2B代扣接口

使用场景： 业务在对接积分捐活动场景时，积分扣除后需要发起活动的B2B扣款，调用本接口来完成扣款。

调用凭证： 应用签名

请求方式： POST（HTTPS）

请求地址： https://test-oapi.gongyi.qq.com/api/reward_donate_service/RewardToDonate

请求参数：

• 请求示例

{
  "activity_no": "123456",
  "project_no": "224328",
  "third_uid": "user_001",
  "reward": 1000,
  "reward_transcode": "trans_7890",
  "money": "5000"
}

返回参数：

注：donate_transcode真实长度为28个字符，后期可能变化，不建议对长度做强校验

返回示例：

{
  "code": 0,
  "msg": "Success",
  "op_time": 1650812345,
  "trace_id": "1a2b3c4d5e6f7g8h1a2b3c4d5e6f7g8h",
  "data": {
    "activity_no": "123456",
    "project_no": "224328",
    "third_uid": "user_001",
    "reward": 1000,
    "money": "5000",
    "reward_transcode": "trans_7890",
    "donate_transcode": "donate_12345",
    "donate_time": "2024-06-01 12:00:00",
    "donate_status": 1,
    "donate_remark": "积分捐测试活动捐赠春蕾计划"
  }
}

3、B2B查单接口

使用场景： 业务在对接积分捐活动场景时，调佣接口B2B扣款后，返回了订单状态为未成功支付，这是需要业务侧重新查单来继续校验该笔订单的状态。

调用凭证： 应用签名

请求方式： POST（HTTPS）

请求地址： https://test-oapi.gongyi.qq.com/api/reward_donate_service/RewardDonateQuery

请求参数：

• 请求示例

{
  "activity_no": "123456",
  "project_no": "224328",
  "third_uid": "user_001",
  "donate_transcode": "donate_12345"
}

返回参数：

返回示例：

{
  "code": 0,
  "msg": "Success",
  "op_time": 1650812345,
  "trace_id": "1a2b3c4d5e6f7g8h1a2b3c4d5e6f7g8h",
  "data": {
    "activity_no": "123456",
    "project_no": "224328",
    "uid": "user_001",
    "reward": 1000,
    "money": "5000",
    "reward_transcode": "trans_7890",
    "donate_transcode": "donate_12345",
    "donate_time": "2024-06-01 12:00:00",
    "donate_status": 1,
    "donate_remark": "积分捐测试活动捐赠春蕾计划"
  }
}

4、得花流程前置积分订单校验接口

使用场景： 业务在对接积分捐活动场景时，积分成功扣除后，需要对接公益侧获得小红花，需要调用前置积分订单校验接口。

调用凭证： 应用签名

请求方式： POST（HTTPS）

请求地址： https://test-oapi.gongyi.qq.com/api/reward_donate_service/ValidateRewardOrder

请求参数：

• 请求示例

{
  "activity_no": "123456",
  "project_no": "224328",
  "third_uid": "user_001",
  "reward_transcode": "reward_12345"
}

返回参数：

返回示例：

{
  "code": 0,
  "msg": "Success",
  "op_time": 1650812345,
  "trace_id": "1a2b3c4d5e6f7g8h1a2b3c4d5e6f7g8h",
  "data": {
    "reward_transcode": "reward_12345",
    "reward_status": 1
  }
}