礼包系统开发指南
提示
接入礼包系统之前,需完成应用配置。在 游戏服务 - 应用配置 中可获取 Client ID 和 Server Secret。请妥善保管这些信息,勿传给他人。
开始
礼包系统接入适用于有请求接口能力的游戏,目前尚未提供完全离线的兑换码服务。
根据您的使用场景,您可以灵活对接以下不同兑换接口之一完成兑换流程。
方式 | 接口名 | 需游戏方校验后台设置的兑换条件 | 需游戏方提供发送道具接口 |
---|---|---|---|
游戏方校验 | /api/v1.0/cdk/game/submit-check | ✓ | ✓ |
游戏方发送 | /api/v1.0/cdk/game/submit-send | ✗ | ✓ |
无服务器兑换 | /api/v1.0/cdk/game/submit-simple | ✗ | ✗ |
游戏方校验 Web | /api/v1.0/cdk/page/submit-check | ✓ | ✓ |
游戏方发送 Web | /api/v1.0/cdk/page/submit-send | ✗ | ✓ |
接入顺序
- 完成应用配置获取 Client ID 和 Server Secret 信息。
- 进入 运营工具-礼包系统-服务器配置 选择性填写游戏方服务 器信息并在其中配置发送通知接收地址用来发送相应道具。
- 创建礼包活动导出兑换码,礼包配置完成准备测试。
- 根据实际业务场景使用对应兑换接口完成兑换。
兑换流程
兑换流程大致是:
- 根据接口文档提交 兑换码 与 配置信息等参数 给兑换接口。
- 兑换接口校验数据合法性。
- 兑换系统根据业务场景选择是否调用 游戏方提供的二次校验接口。(可选,当后台配置二次校验接口时会调用)
- 校验全部通过后根据不同接口判断是否调用 游戏方提供的发送道具接口 完成兑换。(可选,当后台配置发送道具接口时会调用)
有三种不同的兑换接口可以进行兑换,整体对接流程只要对接其一接口即可完成:
名称 | 描述 |
---|---|
游戏方校验 | 如果您将使用服务器对接兑换系统,可以安全地保存密钥信息,并希望每次兑换时能通过您的应用程序来校验是否允许兑换,调用您的接口来发送道具,请使用此流程。 |
游戏方发送 | 如果您将使用服务器对接兑换系统,可以安全地保存密钥信息,并希望调用您的应用程序接口来发送每次兑换的道具,请使用此流程。 |
无服务器兑换 | 如果您希望不开发接口完成兑换流程,调用兑换接口后根据返回值来判断是否兑换失败,请使用此流程。 |
三种兑换场景
游戏方校验
当您请求兑换码 submit-check 接口进行兑换时,兑换系统会核对库存以及提交数据是否正确,兑换系统核对通过后会调用您在后台配置的二次校验接口并将后台设置的条件作为参数传给您来校验。
当您的接口校验通过后会继续将后台配置的奖品内容作为参数调用您的发送道具接口,当发送道具成功完成后本次兑换完成。
游戏方发送
当您请求兑换码 submit-send 接口进行兑换时,兑换系统会核对库存以及提交数据是否正确,核对完成后会继续将后台配置的奖品内容作为参数调用您的发送道具接口,当发送道具成功完成后本次兑换完成。
无服务器兑换
当您请求兑换码 submit-simple 接口进行兑换时,兑换系统会核对库存以及提交数据是否正确,兑换信息验证通过后本次兑换完成并将后台配置的道具信息返回给您。