...
Markdown |
---|
**接口地址** `由第三方企业开发者或中间件开放接口并在自建应用中配置通知地址`
**请求方式** `POST`
**consumes** `["application/json"]`
**produces** `["application/json"]`
**应用权限** `优惠券->券库券码同步`
#请求参数
***
###公共参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| orgId | 企业ID | body | true | String | |
| appInstanceId | 应用实例ID | body | true | String | |
| noticeData | 通知数据 | body | true | array | [优惠券同步通知](#优惠券同步通知) |
| nonce| 签名随机数| string | true | String | 签名随机数 |
| timestamp| 签名时间戳| long | true | Long | 签名时间戳 |
| signature| 签名| string | true | String | 签名 |
###优惠券同步通知
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| batchId | 批次ID,同步任务标识 | body | true | string | |
| thirdCouponTplId | 第三方卡券模板ID | body | false | String | |
| couponType | 卡券类型 | body | false | string | |
###请求示例
```json
{
"orgId": "928a852d-e749-45be-bc31-f8e23f07b7f4",
"appInstanceId": "778985290508406784",
"noticeData": [
{
"batchId": "780862735507394560"
}
],
"nonce": "n04GvACT6Ed768TUlJHKwD2Ml2ej89n0",
"timestamp": 1625793771858 ,
"signature": "1d11d6b2be2113fd42519be97421b1ad0ddcb1e5"
}
```
#响应参数
***
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
| ------ | ------ | ------ | ------ | ------ | ------ |
| code | 状态码 | body | true | string | |
| msg | 描述 | body | true | string | |
###响应状态
| 状态码 | 说明 | schema |
| ------ | ------ | ------ |
| 200 | OK | |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found | |
| 500 | FAIL | |
###响应示例
```json
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "通讯成功"
}
``` |
...