4.13 数据同步
使用说明:
(1)接入方调用数据同步申请接口申请数据文件的生成
(2)接入方每隔5分钟调用数据同步查询接口查询文件生成进度
(3)生成完成,接口返回数据文件url,自行下载使用
4.13.1数据同步申请
请求URL:
测试环境: https://mkt-test.allinpay.com/mngapi/mng/datasync
生产环境: https://mkt.allinpay.com/mngapi/mng/datasync
请求path: /mngapi/mng/datasync
请求入参:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
sync_id |
同步id |
String[32] |
是 |
|
sync_type |
同步类型 |
String[16] |
是 |
TPL_CPLIST:券列表 TPL_CPTRACE:券核销或回退流水明细 |
sync_param |
数据生成参数 |
String[-] |
是 |
Json字符串 不同的同步类型对应不同的参数 |
返回参数:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
ret_code |
接口状态码 |
String(4) |
是 |
200-处理成功 详见附录 |
ret_msg |
接口错误信息 |
String |
是 |
|
result_code |
错误码 |
String(32) |
否 |
SUCCESS-调用成功 详见附录 |
result_msg |
错误信息 |
String |
否 |
|
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
3.5.1.1券列表
请求入参:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
tplid |
券模版id |
String[10] |
是 |
券模版id |
文件格式再约定
3.5.1.2券核销或回退明细
请求入参:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
tplid |
券模版id |
String[10] |
是 |
券模版id |
|
|
|
|
|
use_month |
使用时间月份 |
String[6] |
否 |
|
文件格式再约定
4.13.2数据同步查询
请求URL:
测试环境: https://mkt-test.allinpay.com/mngapi/mng/datasyncqry
生产环境: https://mkt.allinpay.com/mngapi/mng/datasyncqry
请求path: /mngapi/mng/datasyncqry
建议间隔5分钟发起一次查询
请求入参:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
sync_id |
同步id |
String[32] |
是 |
|
返回参数:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
ret_code |
接口状态码 |
String(4) |
是 |
200-处理成功 详见附录 |
ret_msg |
接口错误信息 |
String |
是 |
|
result_code |
错误码 |
String(32) |
否 |
SUCCESS-调用成功 详见附录 |
result_msg |
错误信息 |
String |
否 |
|
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
sync_id |
同步id |
String[32] |
是 |
|
state |
状态 |
String[16] |
是 |
WAIT_GEN:等待生成 GEN_FINISH:生成完成,可下载 GEN_FAIL:生成失败 |
create_time |
创建时间 |
String[14] |
是 |
yyyyMMddHHmmss |
fin_time |
完成时间 |
String[14] |
否 |
yyyyMMddHHmmss |
url |
数据url |
String[256] |
否 |
生成成功必填 |
hashvalue |
hash值 |
否 |
文件的md5sum值 |
4.13.3 核销/回退明细下载
同时包含券类和立减类明细
请求URL:
测试环境: https://mkt-test.allinpay.com/mngapi/mng/
生产环境: https://mkt.allinpay.com/mngapi/mng/dataflow
请求path: /mngapi/mng/dataflow
请求入参:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
sync_type |
同步类型 |
String[16] |
是 |
ACT_DCTRACE:交易立减核销/回退流水 ACT_USEDTRACE :核销明细(包含立减和券) |
sync_param |
数据生成参数 |
String[-] |
是 |
Json字符串 ACT_DCTRACE:{"use_date":"日期yyyyMMdd"} ACT_USEDTRACE:{"use_date":"日期yyyyMMdd"}
|
返回参数:
参数 |
参数名 |
类型[长度限制] |
必填 |
描述 |
ret_code |
接口状态码 |
String(4) |
是 |
200-处理成功 详见附录 |
ret_msg |
接口错误信息 |
String |
是 |
|
result_code |
错误码 |
String(32) |
否 |
SUCCESS-调用成功 详见附录 |
result_msg |
错误信息 |
String |
否 |
|
appid |
应用id |
String[10] |
是 |
基础营销平台分配,与报文头一致 |
sync_id |
同步id |
String[32] |
是 |
|
state |
状态 |
String[16] |
是 |
WAIT_GEN:等待生成 GEN_FINISH:生成完成,可下载 GEN_FAIL:生成失败 |
create_time |
创建时间 |
String[14] |
是 |
yyyyMMddHHmmss |
fin_time |
完成时间 |
String[14] |
否 |
yyyyMMddHHmmss |
url |
数据url |
String[256] |
否 |
生成成功必填 15分钟有效, 默认为zip文件 |
hashvalue |
hash值 |
|
否 |
文件的md5sum值,防止篡改 |
ACT_DCTRACE文件表头格式如下:
活动发起方id,活动id,权益流水号,操作类型try/cce,操作时间,用户身份标识,核销商户,核销门店号,核销代理商号,核销流水,交易类型,订单金额,抵扣金额
ACT_USEDTRACE文件表头格式如下:
活动类型,活动发起方id,活动发起方名称,活动发起方所属分公司,活动id,券/卡模板id,券/卡id,权益流水号,用户身份标识,核销类型,抵用/回退时间,抵扣金额,核销商户,核销商户名称,核销门店,业务流水号,关联原业务流水号,订单金额