文档中心 > API类目 > 芝麻信用API

zhima.merchant.single.data.upload (单条数据传入)

单条数据传入

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.merchant.single.data.upload
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
scene_code String 必须 32 数据应用的场景编码,场景码和场景名称(数字或字符串为场景码)如下:
8:数据反馈
32:骑行
CAR_RENTING:租车行业解决方案
每个场景码对应的数据模板不一样,请使用zhima.merchant.data.upload.initialize接口获取场景码对应的数据模板。
8
data String 必须 4096 传入的json数据,商户通过json格式将数据传给芝麻 , json中的字段可以通过如下步骤获取:首先调用zhima.merchant.data.upload.initialize接口获取数据模板,该接口会返回一个数据模板文件的url地址,如:http://zmxymerchant-prod.oss-cn-shenzhen.zmxy.com.cn/openApi/openDoc/信用护航-负面记录和信用足迹商户数据模板V1.0.xlsx,该数据模板文件详细列出了需要传入的字段,及各字段的要求,data中的各字段就是该文件中列出的字段编码。 {'field1':'value1','field2':'value2'}
primary_keys String 必须 512 主键列使用传入字段进行组合,也可以使用传入的某个单字段(确保主键稳定,而且可以很好的区分不同的数据)。例如order_no,pay_month或者order_no,bill_month组合,对于一个order_no只会有一条数据的情况,直接使用order_no作为主键列 。 order_no,pay_month
biz_ext_params String 可选 256 公用回传参数(非必填),这个字段由商户传入,系统透传给商户,便于商户做逻辑关联,请使用json格式。 {'extparam1':'value1'}
linked_merchant_id String 可选 16 芝麻平台服务商模式下的二级商户标识,如果是直连商户调用该接口,不需要设置 2088721630869411

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
biz_ext_params String 选填 256 公用回传参数(非必填),这个字段由商户传入,系统透传给商户。 {'extparam1':'value1'}
task_id String 选填 64 每次上传都会生成一个任务号 。 2017031700304000000000

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaMerchantSingleDataUploadRequest request = new ZhimaMerchantSingleDataUploadRequest();
request.setBizContent("{" +
"\"scene_code\":\"8\"," +
"\"data\":\"{'field1':'value1','field2':'value2'}\"," +
"\"primary_keys\":\"order_no,pay_month\"," +
"\"biz_ext_params\":\"{'extparam1':'value1'}\"," +
"\"linked_merchant_id\":\"2088721630869411\"" +
"  }");
ZhimaMerchantSingleDataUploadResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"zhima_merchant_single_data_upload_response":{
		"msg":"Success",
		"code":"10000",
		"task_id":"2017031700304000000000",
		"biz_ext_params":"{'extparam1':'value1'}"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 检查字段格式是否符合要求
DATA_IS_EMPTY 数据为空 输入data
ILLEGAL_JSON_FORM json格式不合法 传入正确的json格式
PASSWAY_IS_NOT_EXIST 通道不存在 调用数据上传初始化接口初始化通道,或者联系旺旺号“芝麻信用技术支持”
PRIMARY_KEY_IS_EMPTY 主键为空 输入primary_keys
SCENE_CODE_IS_EMPTY 场景码为空 输入scene_code
SCENE_CODE_IS_NOT_EXIST 场景码不存在 请输入正确scene_code
DATA_PASS_IN_ERROR 数据传入失败 请联系旺旺号“芝麻信用技术支持”
TYPE_ID_IS_NOT_EXIST 通道id不存在 请先调用初始化API接口完成通道初始化
SYSTEM_RUN_FAILURE 系统运行失败 请联系旺旺号“芝麻信用技术支持”

公共错误码

返回
顶部