接口介绍
本接口适用于有自己签约页面的对接方,若没有签约页面,请移步H5自助签约页面,
本接口接受一个图片文件,并转化为链接,上传图片最大限制为5M
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.image.upload |
是 |
app |
String(32) |
接入商标识 |
是 |
version |
String(16) |
调用的接口版本,固定为:2.0 |
是 |
sign_type |
String(32) |
签名类型 MD5、RSA,默认MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 |
是 |
sign |
String(32) |
签名,详见MD5签名、RSA256签名 |
是 |
参数简介
参数名 |
参数类型 |
参数介绍 |
是否必填 |
merchant_code |
String(32) |
第三方商户号(第三方商户号和采宝商户号至少填一个) |
否 |
cb_merchant_code |
String(32) |
采宝商户号(第三方商户号和采宝商户号至少填一个) |
否 |
channel |
String(16) |
签约渠道:MYBANK(银行通道);WECHAT(微信官方) |
是 |
image_type |
String(16) |
图片类型, 具体取值请参照:名词解释 |
是 |
file_item |
binary |
图片文件 |
是 |
返回值说明
公共返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
success |
result |
boolean |
标识这次请求是否成功 |
|
error_code |
result |
String(64) |
错误码 |
|
error_msg |
result |
String(16) |
错误码的详细说明 |
|
request_id |
data |
String(64) |
请求报文ID |
|
request_time |
data |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
返回值说明
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
url |
data |
String(256) |
图片地址 |
返回值举例
{
"data": {
"request_id": "5ad1f599-8e73-4c24-9fbb-d5fbd732d14c",
"request_time": "20190114150144",
"response_time": "20190114150206",
"url": "https://pic.caibaopay.com/open/upload/dcb627eb1f00d2316715ad11dcbec95a.png"
},
"result": {
"success": true
},
"sign": ""
}
js demo
http://agent.caibaopay.com/test/api/v2/uploadImage.htm