法大大电子合同接入方案【模板】

('法大大电子合同接入方案目录1.概述2.规范（重要！请阅读！！！）3.基础接口3.1.个人CA申请接口输入参数输出参数3.2.文档传输接口输入参数输出接口3.3.文档签署接口（自动签）接入参数输出参数3.4.合同归档接口接入参数输出参数3.5.文档下载接口输入参数输出参数1.概述接入方平台需向法大大申请接入（须填写接入申请表格，包括平台域名、服务器IP，客户实名审核模式等），法大大审核后将给接入平台颁发app_id和app_secret。app_id为6位数字，app_secret为24位字符串。接入方需提供其服务器IP以做绑定。典型业务流程：1.客户在接入方平台注册账号2.接入方将个人用户信息（身份证、姓名、邮箱、手机等）同步给法大大，法大大向CA机构申请CA证书。3.调用文件上传接口，将合同文件上传至服务器。4.调用文档签署接口，给文档进行签章。5.调用归档接口，将合同状态置为已完成，并进行存证。2.规范（重要！请阅读！！！）1.FDDServer：请求域名2.Port：法大大接口服务器端口，参见邮件内容3.APP_ID：接入方的ID，参见邮件内容4.APP_SECRET：接入方的密钥，参见邮件内容5.TripleDES（3DES）：DESede/ECB/PKCS5Padding；密钥为APP_SECRET3.基础接口3.1.个人CA申请接口接口类型：HTTPPOST请求调用方向：接入平台->法大大调用场景：可以在接入平台用户注册信息实名审核后即时触发，或自行根据业务而定（但必须在调用文档签署接口前，以保证事先为客户颁发CA证书）接口地址：【网址】接口返回：JSON报文输入参数参数要求描述备注app_id必选接入方IDtimestamp必选请求时间yyyyMMddHHmmssv可选版本号默认为2.0customer_name必选客户姓名email可选电子邮箱ident_type可选证件类型0-身份证（默认值）；1-护照；2-军人身份证；6-社会保障卡；A-武装警察身份证件；B-港澳通行证；C-台湾居民来往大陆通行证；E-户口簿；F-临时居民身份证；F-临时居民身份证；P-外国人永久居留证；id_mobile必选证件号码与手机手机号只支持中国大陆运营商号码使用3DES对数据加密数据格式为：证件号码手机号码示例：身份证号为：手机号码为：则原数据为：msg_digest必选消息摘要Base64(SHA1(appid+MD5(timestamp)+SHA1(appsecret)))输出参数参数要求描述备注result必选处理结果success：成功error：失败code必选状态码1000：操作成功2001：参数缺失或者不合法2002：业务异常，失败原因见msg2003：其他错误，请联系法大大msg必选描述customer_id可选客户编号32位字符3.2.文档传输接口接口类型：HTTPMULTI-PARTPOST请求调用方向：接入平台->法大大调用场景：接入平台生成PDF文档后通过此接口将文档传输到法大大，供签署时使用。非PDF文档请使用合同模板功能（参考合同模板传输接口和合同生成接口）接口地址：【网址】接口返回：JSON报文注：pdf文档需符合PDF字体要求输入参数输出接口参数要求描述备注result必选处理结果success：成功error：失败code必选状态码1000：操作成功2001：参数缺失或者不合法2002：业务异常，失败原因见msg2003：其他错误，请联系法大大msg必选描述3.3.文档签署接口（自动签）接口类型：HTTPPOST请求调用方向：接入平台->法大大接口地址：【网址】接口说明：自动签接口不需要用户亲自操作，当接入平台调用此接口时，即可以在指定的电子合同上签上指定用户的电子章。因此如果需要使用此接口的能力，需要接入平台联系法大大商务签署补充协议。接入参数参数要求描述备注app_id必选接入方IDtimestamp必选请求时间yyyyMMddHHmmssv可选版本号默认为2.0；版本为2.1时，返回3DES处理后的下载/参数要求描述备注app_id必选接入方IDv可选版本号默认为2.0timestamp必选请求时间yyyyMMddHHmmsscontract_id必选合同编号只允许长度<=32的英文或数字字符doc_title必选合同标题如“xx投资合同”doc_url可选文档地址文档地址doc_url和file两个参数必选一file可选PDF文档File文件doc_url和file两个参数必选一doc_type必选文档类型.pdfmsg_digest必选消息摘要Base64(SHA1(app_id+MD5(timestamp)+SHA1(app_secret+contract_id)))查看地址transaction_id必选交易号每次请求视为一个交易。只允许长度<=32的英文或数字字符。交易号为接入平台生成，必须保证唯一并自行记录。contract_id必选合同编号根据合同编号指定在哪份文档上进行签署。合同编号在文档传输或合同生成时设定。customer_id必选客户编号CA注册时获取。client_role必选客户角色1-接入平台2-担保公司3-投资人4-借款人如果需要开通自动签权限请联系法大大的商务签署补充协议。doc_title必选文档标题如“xx投资合同”sign_keyword必选定位关键字关键字为文档中的文字内容（要能使用ctrl+f搜索到）。法大大按此关键字进行签章位置的定位，将电子章盖在这个关键字上面。凡出现关键字的地方均会盖上指定用户的电子章，建议关键字在合同中保持唯一。notify_url可选签署结果异步通知URL如果指定，当签章完成后，法大大将向此URL发送签署结果。参见签署结果异步通知规范（notify_url）msg_digest必选消息摘要Base64(SHA1(app_id+MD5(transaction_id+timestamp)+SHA1(app_secret+customer_id)))输出参数参数要求描述备注result必选处理结果success：成功error：失败code必选状态码1000：操作成功2001：参数缺失或者不合法2002：业务异常，失败原因见msg2003：其他错误，请联系法大大msg必选描述download_url可选合同下载地址viewpdf_url可选合同查看地址3.4.合同归档接口接口类型：HTTPPOST请求调用方向：接入平台->法大大调用场景：接入平台更新合同签署状态为-签署完成，法大大将把合同所有相关操作记录进行归档存证。归档后将不能再对文档再进行签署操作。接口地址：【网址】接口返回：JSON报文接入参数输出参数参数要求描述备注result必选处理结果success：成功error：失败code必选状态码1000：操作成功2001：参数缺失或者不合法2002：业务异常，失败原因见msg2003：其他错误，请联系法大大msg必选描述3.5.文档下载接口接口类型：HTTPGET请求调用方向：接入平台->法大大接口说明：通过合同编号下载文档（PDF格式）接口地址：【网址】参数要求描述备注app_id必选接入方IDv可选版本号默认为2.0timestamp必选请求时间yyyyMMddHHmmsscontract_id必选合同编号合同编号msg_digest必选消息摘要Base64(SHA1(app_id+MD5(timestamp)+SHA1(app_secret+contract_id)))接口返回：正常时直接返回PDF文档（MIME:application/pdf），异常时返回JSON报文注：可不接入，直接使用签署结果通知中返回的地址输入参数参数要求描述备注app_id必选接入方IDv可选版本号默认为2.0timestamp必选请求时间yyyyMMddHHmmsscontract_id必选合同编号msg_digest必选消息摘要Base64(SHA1(app_id+MD5(timestamp)+SHA1(app_secret+contract_id)))输出参数注：下载异常是返回JSON报文，正常是返回文件流参数要求描述备注result必选处理结果success：成功error：失败code必选状态码1000：操作成功2001：参数缺失或者不合法4001：无效交易号4002：文档已删除（已下载）4003：其他原因msg必选描述',)