HTTP/HTTPS
请求协议
OAPI接口服务市场 / OpenAPI / 电子合同模板填充
电子合同模板填充
接口地址：https://www.oapi.cc/store/App.Esign.GenerateContract
接口描述： 将需填充的内容通过模板填充接口传入，即可生成合同供签署操作
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 必须 | - | 访问令牌，生成令牌可使用App.Auth.ApplyToken接口 | |
| doc_title | 字符串 | 必须 | - | 文档标题、合同标题 | |
| template_id | 字符串 | 必须 | - | 模板编号 | |
| contract_id | 字符串 | 必须 | - | 合同编号 | |
| font_size | 字符串 | 可选 | - | 字体大小，如传入该参数，则按照该参数值设置字体大小；参考word字体设置，例如：10,12,12.5,14；若未传入该参数，则文本域字体大小按照文本域设置时的大小（文本域设置为自动，则由系统计算字体大小） | |
| font_type | 字符串 | 可选 | - | 字体类型，默认0-宋体；0-宋体；1-仿宋；2-黑体；3-楷体；4-微软雅黑 | |
| parameter_map | 字符串JSON格式 | 必须 | - | 填充内容 JsonObject字符串key为文本域，value为要填充的值，value值传字符类型示例：{"platformName":"The Earth","borrower":"BossHorse"} | |
| dynamic_tables | 字符串JSON格式 | 可选 | - | JsonArray[dynamic_table]字符串每个dynamic_table 元素表示一个动态表单，可以生成多个表格。示例（包含两个表格）：[{"datas":[["1","小网","小易","1000"],["2","小云","小音","2000"],["3","小乐","天马","3000"]],"headers":["序号","借款人","贷款人","金额"],"colWidthPercent":[1,4,4,4], "cellHeight":30,"cellHorizontalAlignment":0,"cellVerticalAlignment":5,"pageBegin":1,"theFirstHeader":"附一"}] |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.contract_id | 字符串 | 合同号,后续签署需要 |
| data.download_url | 字符串 | 合同下载地址 |
| data.viewpdf_url | 字符串 | 合同查看地址 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 必须 | |
| doc_title | 必须 | |
| template_id | 必须 | |
| contract_id | 必须 | |
| font_size | 可选 | |
| font_type | 可选 | |
| parameter_map | 必须 | |
| dynamic_tables | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/App.Esign.GenerateContract.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2025-05-04 21:57:00