第三方优惠券接口

如果您有自己的优惠券、奖品系统,那么,您可在24好玩平台上创建的活动中使用您自有的优惠券、奖品系统。目前这个高级设置功能只对特殊用户开放,如有需求,请联系客服人员。

下面,这篇文档会指引您如何将您的自有优惠券、奖品系统和您的24好玩平台对接:

1. 在高级设置中配置您的优惠券接口

您需要按照24好玩平台的接口约定(接口对接说明在本文下方),提供两个接口:

  1. 优惠券列表查询接口
  2. 优惠券发放接口

注意:如您的优惠券不是在微信中使用,而是需要发到另一个帐号体系,如您的APP用户账号下,需配置第三方登录功能设置。

图1

2. 在创建活动的过程中,可以在编辑奖品弹窗中使用您的优惠券奖品

当高级设置中的优惠券奖品功能配置成功并且启用后,您就可在配置活动页面中的编辑奖品弹窗中使用优惠券奖品,并且可编辑优惠券奖品。如图2:

图2

3. 错误处理

如果您在高级设置中配置的接口有错,玩家是会领奖失败的,如图3,所以请确保接口根据我们提供的接口对接说明进行编辑。

图3

接口对接说明

为了您能成功使用第三方优惠券功能,您需要按照以下约定来提供接口:

接口数据安全:在和24好玩平台对接接口时,需要先了解【开放接口签名】

1. 查询优惠券接口

24好玩会调用这个接口获取您的优惠券列表。

请求方式:POST 请求
请求参数说明(Request Body)
请求头:Content-Type: application/json
参数 说明
page 页码,默认为 1
page_size 每页显示的数量,默认每页 10 条
sign 签名
返回参数说明 Response Body
返回头:Content-Type: application/json
参数 说明
code 错误码,0 为成功
msg 错误描述,msg 会直接展示给玩家
result 返回结构
返回错误码说明 Error Code
错误码 说明
7100 sign 校验错误
9003 获取优惠券列表异常
接口详细说明
/**
 * @apiDescription    查询优惠券列表
 * @api               {POST}
 * @apiVersion        1.0.0
 * @apiHeader         (Reqeust Headers) Contnet-Type application/json
 *
 * @params            {int}         page               页码,默认为1
 * @params            {int}         page_size          每页显示数量,默认每页10条
 * @params            {str}         sign               签名
 *
 * @apiSuccess        {int}         code               返回码
 * @apiSuccess        {str}         msg                错误描述
 * @apiSuccess        {str}         result             返回结构
 *
 * @apiSuccessExample {json}        Success-Response:
 *    {
 *        code : 0,
 *        msg : "ok",
 *        result: {
 *           count: 3,                       // 此字段必选,优惠券总数
 *           title: {                        // 此字段必选,与列表中优惠券字段对应。name 字段会在工作台展示为:名称
 *              name: "名称"
 *           },
 *           ignore: "id,name",              // 此字段可选,默认展示所有字段。示例表示 id、name 字段不在工作台列表展示。多字段用 , 隔开
 *           list: [
 *              {
 *                  id: 110,                 // 必选,优惠券ID
 *                  name: "优惠券1",          // 必选,优惠券名称
 *                  num: 16,                 // 可选,优惠券数量
 *                  type: "优惠券",           // 可选,优惠券类型
 *                  des: "描述",              // 可选,优惠券描述
 *                  valid_date: "2017-11-17",  // 可选,优惠券过期时间
 *               },
 *              {
 *                  id: 111,                 // 优惠券ID
 *                  name: "优惠券2",          // 优惠券名称
 *                  num: 16,                 // 可选,优惠券数量
 *                  type: "优惠券",           // 可选,优惠券类型
 *                  des: "描述",              // 可选,优惠券描述
 *                  valid_date: "2017-11-17",  // 可选,优惠券过期时间
 *               },
 *              {
 *                  id: 112,                // 优惠券ID
 *                  name: "优惠券3",         // 优惠券名称
 *                  num: 16,                 // 可选,优惠券数量
 *                  type: "优惠券",           // 可选,优惠券类型
 *                  des: "描述",              // 可选,优惠券描述
 *                  valid_date: "2017-11-17",  // 可选,优惠券过期时间
 *               }
 *           ] 
 *        }
 *    }
 * @apiErrorExample   {json}        error_code: 7100
 *    {
 *        code : 7100,
 *        msg : "token error"       // token错误
 *        result: ""
 *    }
 * @apiErrorExample   {json}        error_code: 9003
 *    {
 *        code : 9003,
 *        msg : "coupon list err",  // 获取优惠券列表异常
 *        result: ""
 *    }
 */

2. 发放优惠券接口

在您成功为您的活动配置了第三方优惠券之后,当玩家在您的活动中获奖时,24好玩会调用这个接口来发放优惠券。

请求类型:POST
请求参数说明(Request Body)
请求头:Content-Type: application/json
参数 说明
u_id 玩家 ID
coupon_id 优惠券ID
game_id 活动ID,可选
game_name 活动名称,可选
sign 签名
返回参数说明(Response Body)
Content-Type: application/json
参数 说明
code 错误码,0 为成功
msg 错误描述,msg 会直接展示给玩家
result 返回结构
返回错误码说明(Error Code)
错误码 说明
7100 sign 校验错误
8000 用户不存在
9004 发放优惠券异常
接口详细说明
/**
 * @apiDescription    发放优惠券接口
 * @api               {POST}
 * @apiVersion        1.0.0
 * @apiHeader         (Reqeust Headers) Contnet-Type application/json
 *
 * @params            {str}         u_id               用户ID
 * @params            {str}         coupon_id          优惠券ID
 * @params            {str}         game_id            活动ID(可选)
 * @params            {str}         game_name          活动名称(可选)
 * @params            {str}         sign               签名
 *
 * @apiSuccess        {int}         code               返回码
 * @apiSuccess        {str}         msg                错误描述
 *
 * @apiSuccessExample {json}        Success-Response:
 *    {
 *        code : 0,
 *        msg : "ok",
 *        result: {
 *           cd_key: "abcdefg"     // 可选,优惠券兑换码
 *           type: "优惠券",        // 可选,优惠券类型
 *           des: "描述",           // 可选,优惠券类型
 *        }
 *    }
 * @apiErrorExample   {json}        error_code: 7100
 *    {
 *        code : 7100,
 *        msg : "token error"       // token错误
 *        result: ""
 *    }
 * @apiErrorExample   {json}        error_code: 8000
 *    {
 *        code : 8000,
 *        msg : "no user",          // 用户不存在
 *        result: ""
 *    }
 * @apiErrorExample   {json}        error_code: 9004
 *    {
 *        code : 9004,
 *        msg : "send coupon err"   // 发放优惠券异常
 *        result: ""
 *    }
 */

results matching ""

    No results matching ""