zhima.data.state.data.sync(芝麻业务状态数据同步接口) 在线调试(沙箱环境)

对接芝麻产品后,需要商户将用户发生的实时数据按照各状态所需的格式同步到芝麻,以方便产品推进状态机运行。(如:约定产品,需要淘票票在用户购票状态同步回芝麻,以方便芝麻推进约定状态)

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.data.state.data.sync
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必选 64 蚂蚁统一会员ID 2088开头
out_biz_no String 必选 128 外部业务订单流水号 外部业务订单统一编号
out_principal_id String 必选 128 外部主体唯一id。(如淘票票中的电影id) 1303902
biz_state_code String 必选 64 此状态需要与产品负责人沟通,每个产品维护了不同的状态机。(如约定产品,在电影场景下,需要淘票票商户在用户购票后同步购票信息,则此code=CONTRACT_STATE_WATCH_MOVIE_BUY) CONTRACT_STATE_WATCH_MOVIE_BUY
category_code String 必选 64 此类目为分配给商户在一个信用服务下的不同类目分类,(如约定产品下的电影类目) WATCH_MOVIE
service_id String 必选 128 芝麻信用service_id,商户在入驻芝麻信用商户平台后,创建信用服务完成时会生成唯一的service_id。 2019080700000000000001800100
biz_data String 必选 4096 同步的数据具体内容(json字符串),开发前与技术对接,将会给出需要的字段模型 {"buyCnt":3,"cinemaAdderess":"杭华街","cinemaId":0,"cinemaLocation":"经纬度","cinemaName":"自由人影城","endTime":"2020-01-25 15:00:00","extInfo":"json","orderNo":"100220200103194523683","scheduleId":"12312","seatId":"222","startTime":"2020-01-25 12:30:00"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
biz_result String 必填 128 同步结果成功或失败,具体错误码在错误信息中 success/failed

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaDataStateDataSyncRequest request = new ZhimaDataStateDataSyncRequest();
request.setBizContent("{" +
"\"user_id\":\"2088开头\"," +
"\"out_biz_no\":\"外部业务订单统一编号\"," +
"\"out_principal_id\":\"1303902\"," +
"\"biz_state_code\":\"CONTRACT_STATE_WATCH_MOVIE_BUY\"," +
"\"category_code\":\"WATCH_MOVIE\"," +
"\"service_id\":\"2019080700000000000001800100\"," +
"\"biz_data\":\"{\\\"buyCnt\\\":3,\\\"cinemaAdderess\\\":\\\"杭华街\\\",\\\"cinemaId\\\":0,\\\"cinemaLocation\\\":\\\"经纬度\\\",\\\"cinemaName\\\":\\\"自由人影城\\\",\\\"endTime\\\":\\\"2020-01-25 15:00:00\\\",\\\"extInfo\\\":\\\"json\\\",\\\"orderNo\\\":\\\"100220200103194523683\\\",\\\"scheduleId\\\":\\\"12312\\\",\\\"seatId\\\":\\\"222\\\",\\\"startTime\\\":\\\"2020-01-25 12:30:00\\\"}\"" +
"  }");
ZhimaDataStateDataSyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_data_state_data_sync_response": {
        "code": "10000",
        "msg": "Success",
        "biz_result": "success/failed"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "zhima_data_state_data_sync_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 请联系芝麻技术支持
ZMDATA.USER_ID_ERROR 用户ID为空或不正确 请检查用户ID(user_id)参数
ZMDATA.OUT_BIZ_NO_NULL 外部订单号不可空 请确认您的外部订单号参数(out_biz_no)
ZMDATA.OUT_PRINCIPAL_ID_ERROR 外部主体唯一ID错误 请确认外部主体唯一id是否正确(out_principal_id)
ZMDATA.BIZ_STATE_CODE_ERROR 业务状态码错误 请联系芝麻产品或技术人员,确认biz_state_code值是否正确
ZMDATA.CATEGORY_CODE_ERROR 类目编码不正确 请联系芝麻产品或技术人中,确认category_code值是否正确
ZMDAT.SERVICE_ID_ERROR 服务id不正确 请联系芝麻产品或技术人员,确认service_id值是否正确
ZMDATA.BIZ_DATA_ERROR 业务数据错误或格式不正确 请联系芝麻技术人员,确认数据模型及格式是否正确(biz_data)
onlineServer