zhima.customer.contract.initialize(芝麻可信电子合约初始化) 在线调试(沙箱环境)

芝麻可信电子合约初始化,可信电子合约初始化后才能使用可信电子合约、电子签名

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.customer.contract.initialize
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_code String 必选 32 芝麻认证产品码,示例值为真实的产品码 w1010100000000002978
contract_name String 必选 64 合约名称,会展示给签约方 《XXXXX合同》
contract_file String 必选 512000 合约内容,必须是PDF文件流,BASE64编码 JVBERi0xLjUNCjQgMCBvYmoNCjw8L1R5cGUgL1BhZ2UvUGFyZW50IDMgMCBSL0NvbnRlbnRzIDUgMCBSL01lZGlhQm94IFswIDAgNTk1LjI5OTk4Nzc5IDg0MS45MDAw

响应参数

参数 类型 是否必填 最大长度 描述 示例值
contract_no String 必填 32 电子合约号,后续的电子签名流程需要用到 e31b9cde3216dca1394cf4fa73e464e6

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaCustomerContractInitializeRequest request = new ZhimaCustomerContractInitializeRequest();
request.setBizContent("{" +
"\"product_code\":\"w1010100000000002978\"," +
"\"contract_name\":\"《XXXXX合同》\"," +
"\"contract_file\":\"JVBERi0xLjUNCjQgMCBvYmoNCjw8L1R5cGUgL1BhZ2UvUGFyZW50IDMgMCBSL0NvbnRlbnRzIDUgMCBSL01lZGlhQm94IFswIDAgNTk1LjI5OTk4Nzc5IDg0MS45MDAw\"" +
"  }");
ZhimaCustomerContractInitializeResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_customer_contract_initialize_response": {
        "code": "10000",
        "msg": "Success",
        "contract_no": "e31b9cde3216dca1394cf4fa73e464e6"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后再试
INVALID_PARAMETER 参数有误 根据错误码描述修改入参后再重试
BIZ_ERROR 业务异常,合约初始化失败 请根据错误码描述检查错误原因
ARRANGEMENT_ERROR 合约异常 请确定的产品码正确,合约已经生效,并且包含此业务的权限
onlineServer