1 简介

 本文档适用于代理商对商户进行操作的接口调用,主要包含了商户新增、商户部分信息修改、商户备案材料上传。    

 文档中所有未标明请求方式的接口皆为POST方式调用。 

 接口访问需要添加IP白名单,请联系我司相关支撑人员。

2 公共请求头 Authorization

Authorization为“APPID:timestamp:sign”字符串的Base64编码值,其中冒号为半角。

请求头示例如下:

POST   v1/merchant/update
Content-Type:multipart/form-data
Authorization:
MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi

Authorization的生成构成

参数名称必选类型描述
appIdLong调用接口的APPID
TimestampLong当前时间戳,毫秒数。不能和当前时间偏差5分钟
signString签名方式:拼接字符 APPID:APPSECRET:timestamp的MD5值


示例代码

sign = DigestUtil.md5Hex(APPID+":"+APPSECRET+":"+timestamp)


3 接口说明

3.0  接口域名(BaseUrl)

http://mt.v3.quanmayun.com:8090

3.1 新增商户

请求地址:
{BaseUrl}/v1/merchant/create
Authorization : Content-Type: multipart/form-data


请求参数:

参数名称必选类型描述
merchantJson字符串{ name|string|必填|商户名称
districtName|string|必填|省份
address|string|必填|商户地址
oldCustomer|int|必填|新老客户,0为新客户,1为老客户
creditCode|string|必填|营业执照代码
idcardName|string|必填|法人身份证姓名
idcardNumber|string|必填||法人身份证号码
phone|string|必填|法人手机号
bankName|string|必填|开户银行
bankAccount|string|必填|对公账号
dataSource|string|必填|数据来源
sceneDescription|string|必填|场景描述speechcraft|string|必填|话术内容 }
img文件营业执照pdf文件
idcardPic文件法人身份证(正反面)pdf文件
officePic文件办公室及门头照片pdf文件
attachment文件其他材料附件zip/rar/7z文件

返回参数

参数名称必选类型描述
codeint200正常,其他异常
dataobject暂无数据
successboolean成功是true,异常是false
msgstring操作成功代表成功,其他为错误信息

请求消息示例如下:

POST {BaseUrl}/v1/merchant/create
Content-Type: multipart/form-data
Authorization :
MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi
{
merchant:{
"name":"山水科技",
"districtName":"江苏省",
"address":"江苏省南京市玄武区XXXXXXX",
"oldCustomer":1,
"creditCode":"7965136547",
"idcardName":"李四",
"idcardNumber":"320896569563244562",
"phone":"15263959874",
"bankName":"工商银行",
"bankAccount":"5626325741415263",
"dataSource":"公司官网",
"sceneDescription":"衣服干洗、鞋靴清洁、箱包养护等服务",
"speechcraft":"销售:xxx,您好,我是xx软件的xx,你之前有来咨询过客户开发营销管理软件,我们最近出了新功能跟数据,您看明天上午10点还是下午2点有时间?我们带电脑过去给您再做个详细了解。
客户:你们都有什么功能啊
销售:我们系统功能是比较全面的,从获客,营销到客户管理 以及后续的报价 订单 合同一系列流程都有的,包括工厂erp也是有的,您明天方便的话我去拜访您 给您当面演示一下吧"}

Img: 营业执照pdf文件

idcardPic: 法人身份证(正反面)pdf文件

officePic: 办公室及门头照片pdf文件

attachment: 其他材料附件zip/rar/7z文件

}

响应消息示例如下:

{
 "code": 200,
 "success": true,
 "data": {},
 "msg": "操作成功"
 }

{
    "code": 4104,
    "success": false,
    "data": {},
    "msg": "系统:来源IP不在应用的IP白名单里"
}


3.2  商户部分信息修改

请求地址:
{BaseUrl}/v1/merchant/update
Authorization : Content-Type: multipart/form-data

请求参数:

参数名称必选类型描述
merchantJson字符串{
name|string|必填|商户名称
address|string|选填|商户地址
creditCode|string|选填|营业执照代码
idcardName|string|选填|法人身份证姓名
idcardNumber|string|选填||法人身份证号码
phone|string|选填|法人手机号
bankName|string|选填|开户银行
bankAccount|string|选填|对公账号
dataSource|string|选填|数据来源
sceneDescription|string|选填|场景描述 }
img文件营业执照pdf文件
idcardPic文件法人身份证(正反面)pdf文件
officePic文件办公室及门头照片pdf文件

返回参数

参数名称必选类型描述
codeint200正常,其他异常
successboolean成功是true,异常是false
dataobject暂无数据
msgstring操作成功代表成功,其他为错误信息

请求消息示例如下:

POST {BaseUrl}/v1/merchant/update
Content-Type: multipart/form-data
Authorization :
MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi
{
merchant:{
"name":"山水科技",
"address":"江苏省南京市玄武区XXXXXXX",
"creditCode":"7965136547",
"idcardName":"李四",
"idcardNumber":"320896569563244562",
"phone":"15263959874",
"bankName":"工商银行",
"bankAccount":"5626325741415263",
"dataSource":"公司官网",
"sceneDescription":"衣服干洗、鞋靴清洁、箱包养护等服务"}

Img: 营业执照pdf文件

idcardPic: 法人身份证(正反面)pdf文件

officePic: 办公室及门头照片pdf文件

}

响应消息示例如下:

{
 "code": 200,
 "success": true,
 "data": {},
 "msg": "操作成功"
 }

{
    "code": 4104,
    "success": false,
    "data": {},
    "msg": "系统:来源IP不在应用的IP白名单里"
}


3.3  商户备案资料上传

请求地址:
{BaseUrl}/v1/merchant/record
Authorization : Content-Type: multipart/form-data

请求参数:

参数名称必选类型描述
merchantJson字符串{ name|string|必填|商户名称 }
applicationFile文件点击拨号业务申请书 pdf文件
commitmentFile文件点击拨号业务承诺书pdf文件

返回参数:

参数名称必选类型描述
codeint200正常,其他异常
successboolean成功是true,异常是false
dataobject暂无数据
msgstring操作成功代表成功,其他为错误信息

请求消息示例如下:

POST {BaseUrl}/v1/merchant/record
Content-Type: multipart/form-data
Authorization :
MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi

{
merchant:{"name":"山水科技"}

applicationFile : 点击拨号业务申请书 pdf文件

commitmentFile: 点击拨号业务承诺书pdf文件

}

响应消息示例如下:

{
 "code": 200,
 "success": true,
 "data": {},
 "msg": "操作成功"
 }