建立優惠券

介面說明

1、创建优惠券
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/user/coupon/create

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

請求體參數說明

UserCouponRule

Unconditional

FullReduce

範例

https://api.polyv.net/live/v4/user/coupon/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

請求體json參數：

{
    "availableAmount": 999,
    "dayOfUse": 30,
    "description": "买一送一",
    "name": "优惠券2号",
    "receiveEndTime": 1756102918736,
    "receiveStartTime": 1748326918736,
    "rule": {
        "condition": "UNCONDITIONAL",
        "limitPerPerson": -1,
        "unconditional": {
            "enable": true,
            "unit": "MONEY",
            "value": 1.0
        }
    },
    "type": "MAX_OUT",
    "useEndTime": 1756102918737,
    "useStartTime": 1748326918737,
    "useTimeType": "RANGE"
}

回應參數說明

Data參數說明

Error參數說明

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增优惠券
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createCouponTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/coupon/create";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("name", "优惠券2号");
    jsonMap.put("useTimeType", "RANGE");
    jsonMap.put("dayOfUse", 30");    
    jsonMap.put("receiveStartTime", 1756102918736L);
    jsonMap.put("receiveStartTime", 1748326918736L);
    jsonMap.put("useStartTime", 1748326918737L);    
    jsonMap.put("useEndTime", 1756102918737L);                
    Map<String, Object> rule = new HashMap<>();                
    rule.put("condition", "UNCONDITIONAL");        
    rule.put("limitPerPerson", -1);   
    Map<String, Object> unconditional = new HashMap<>(); 
    unconditional.put("enable", true);   
    unconditional.put("unit", "MONEY"); 
    unconditional.put("value", 1.0);                 
    rule.put("unconditional", unconditional);                  
    jsonMap.put("rule", rule);  
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新建优惠券结果：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data":"caqfi6rqutunvofor5jrqbinswh14p2g", // 优惠券ID
    "success": true,
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}