alipay.eco.sign.flow.create(创建流程(E签宝)) 在线调试(沙箱环境)

创建流程(E签宝)

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
target_app_id String 32 被调用的应用ID,仅当被调用的API为第三方ISV提供时有效 2018091661395324
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.sign.flow.create
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
business_scene String 必选 32 流程主题 商品签收
template_infos TemplateInfo[] 必选 模板信息
template_id String 必填 32 模板id 6b95e887c4b342a8b6501bd334b286df
name String 必填 100 文件名称 iphone手机签收单
fill_contents FillContent[] 必填 模板填充项
struct_key String 必填 32 模板组件自定义key name
value String 必填 25 模板值,该值长度取决于配置模板时该字段的限制 2019-12-13
signfields SignField 必填 签署区
struct_key String 必填 32 模板组件id 18247776929e433784636126b33b08a3
auto_execute String 必填 10 平台自动签 true
signer Signer 必填 签署人信息
user_id String 必填 32 支付宝userId 2088102924502823
name String 可选 100 姓名 姓名
id_type String 可选 32 证件类型,详见个人证件类型说明(http://open.esign.cn/docs/xy/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3/%E9%99%84%E5%BD%95/%E4%B8%AA%E4%BA%BA%E8%AF%81%E4%BB%B6%E7%B1%BB%E5%9E%8B.html),默认CRED_PSN_CH_IDCARD (证件号不为空,则必填) CRED_PSN_CH_IDCARD
id_number String 可选 32 证件号 330304199806083911
mobile String 可选 16 手机号 18888888888
email String 可选 64 邮箱 593100192@tsign.cn
attachments Attachment[] 必选 附件信息
file_id String 可选 32 流程附件id b1e4950792114af98f2a6b70953f8a62
attachment_name String 可选 100 流程附件名称 订单截图
config_info ConfigInfo 必选 流程配置信息
platform_order_no String 必填 64 平台订单号 DD1234
company_no String 可选 32 公司编号-SF SF
serial_no String 可选 100 物流单号 1576726491.1902587
jump_url String 可选 300 支付宝小程序跳转 alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821
collect_attachement Boolean 必填 10 是否收集附件 true
attachment_explain AttachmentExplain 可选 附件信息(collect_attachement值为true时必填)
title String 可选 100 附件标题(collect_attachement值为true时必填 请上传手机照片
description String 可选 400 描述 请仔细检查手机外观,如有划痕部位请仔细拍摄。
allow_more_uploads Boolean 可选 32 是否允许上传更多附件 (collect_attachement值为true时必填) true
details Detail[] 可选 附件列表
code String 可选 36 英文描述(collectAttachement值为true时必填)
以下是系统固定code,对上传的图片做相应的校验。
身份证校验情况:
身份证正面照片:ESIGN_IDCARD
身份证背面照片:ESIGN_BACK_IDCARD
phonePicture
description String 可选 100 请上传手机正面照 中文描述(collectAttachement值为true时必填)
order Number 可选 100 顺序(collectAttachement值为true时必填) 1
collect_cert_types String[] 可选 64 收集证件类型列表 ["IDCARD"]
notice_developer_url String 可选 300 回调地址,签署的过程和签署完成都会回调。 https://abc.com/callback
contract_validity Number 可选 100 文档过期时间 1577243641153

响应参数

参数 类型 是否必填 最大长度 描述 示例值
flow_id String 必填 32 流程Id 56b75290982d472b8d60133cd9a747a3

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoSignFlowCreateRequest request = new AlipayEcoSignFlowCreateRequest();
request.setBizContent("{" +
"\"business_scene\":\"商品签收\"," +
"      \"template_infos\":[{" +
"        \"template_id\":\"6b95e887c4b342a8b6501bd334b286df\"," +
"\"name\":\"iphone手机签收单\"," +
"          \"fill_contents\":[{" +
"            \"struct_key\":\"name\"," +
"\"value\":\"2019-12-13\"" +
"            }]," +
"\"signfields\":{" +
"\"struct_key\":\"18247776929e433784636126b33b08a3\"," +
"\"auto_execute\":\"true\"," +
"\"signer\":{" +
"\"user_id\":\"2088102924502823\"," +
"\"name\":\"姓名\"," +
"\"id_type\":\"CRED_PSN_CH_IDCARD\"," +
"\"id_number\":\"330304199806083911\"," +
"\"mobile\":\"18888888888\"," +
"\"email\":\"593100192@tsign.cn\"" +
"          }" +
"        }" +
"        }]," +
"      \"attachments\":[{" +
"        \"file_id\":\"b1e4950792114af98f2a6b70953f8a62\"," +
"\"attachment_name\":\"订单截图\"" +
"        }]," +
"\"config_info\":{" +
"\"platform_order_no\":\"DD1234\"," +
"\"company_no\":\"SF\"," +
"\"serial_no\":\"1576726491.1902587\"," +
"\"jump_url\":\"alipays://platformapi/startapp?appId=2019042364288308&page=pages%2Fwater%2Fwater%3FactivityId%3D0ow26mr0eowt22mqz1gap8bale802821\"," +
"\"collect_attachement\":true," +
"\"attachment_explain\":{" +
"\"title\":\"请上传手机照片\"," +
"\"description\":\"请仔细检查手机外观,如有划痕部位请仔细拍摄。\"," +
"\"allow_more_uploads\":true," +
"          \"details\":[{" +
"            \"code\":\"phonePicture\"," +
"\"description\":\"中文描述(collectAttachement值为true时必填)\"," +
"\"order\":1" +
"            }]" +
"      }," +
"        \"collect_cert_types\":[" +
"          \"[\\\"IDCARD\\\"]\"" +
"        ]," +
"\"notice_developer_url\":\"https://abc.com/callback\"," +
"\"contract_validity\":1577243641153" +
"    }" +
"  }");
AlipayEcoSignFlowCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_eco_sign_flow_create_response": {
        "code": "10000",
        "msg": "Success",
        "flow_id": "56b75290982d472b8d60133cd9a747a3"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
PARAM_ERROR 参数错误:{具体错误描述} 请根据接口文档检查请求参数,修改后重新发起请求
SYSTEM_ERROR 系统繁忙 系统错误:{具体错误描述}。请根据接口文档检查请求参数,修改后重新发起请求。
SERIAL_NO_IS_EXIST 已存在相同的物流单号 更换物流单号
onlineServer