Skip to main content

商户注册领券

1. 前言：​

2. 交互时序图：​

3. 请求场景：​

供应商根据手机号码进行注册并发放优惠券

4. 接口要求：​

使用来伊份openapi加密协议进行加密请求

5. 接口标准​

5.1 基本信息​

描述值
服务名称activity-endorsement
URL测试环境（v1.1）：http://openapi.test.laiyifen.com/activity-endorsement/endorsement/coupon-activity/v1/regist
生产环境（v1.1）：http://openapi.laiyifen.com/activity-endorsement/endorsement/coupon-activity/v1/regist
认证方式令牌
请求方式HTTP(POST)

5.2 请求头公共参数 （Header）​

参数名字参数类型是否必须说明
X-Co-ClientString是客户端Id（来伊份提供）
X-Co-SignString是签名
X-Co-TimeStampString是签名时间戳

5.3 入参 Body​

参数名字参数类型是否必须说明
mobileString是注册领券的手机号
batchIdsList<String>是优惠券批次号

5.4 入参示例​

{
  "mobile": "1300000000",
  "batchIds": [
    "ca03723881629a3edc6ee8224258885f",
    "652e5b87f040ffcd07535c1d3b217b49"
  ]
}

5.5 返回统一参数​

参数名字参数类型是否必须说明
codeString是返回请求业务代码
msgString是返回信息描述
dataJson是返回参数

5.6 返回参数Data​

参数名字参数类型是否必须说明
codeString是优惠券批次领券状态码0：领券成功,3：领取失败，超过领取总次数限制,4：领取失败，超过单日领取次数限制,5：领取失败，优惠券已过期,6：领取失败，优惠券已关闭,9：领取失败，指定用户领取,10：领取失败，券已领完,11：领取失败
couponBatchEncryptionStrString是优惠券批次加密编号
msgString是优惠券领取失败原因
couponCodeString是优惠券券号

5.7 返回示例​

{
    "code":0,
    "msg":"success",
    "data":[
        {
            "code":"0",
            "msg":"领取成功",
            "couponBatchEncryptionStr":"ca03723881629a3edc6ee8224258885f",
            "couponCode":"11111"
        },
        {
            "code":"3",
            "msg":"领取失败，超过领取总次数限制",
            "couponBatchEncryptionStr":"652e5b87f040ffcd07535c1d3b217b49",
            "couponCode":""
        }
    ]
}