开放文档API

curl -X POST 'https://your-api-host.com/template/uploadContractFile' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-F 'file=@/path/to/your/contract_template.pdf'
									

{
  "code": "200",
  "msg": "成功",
  "data": { // 合同文件上传结果
    "fileName": "contract_template.pdf",
    "fileUrl": "group1/M00/00/02/...", // 实际存储路径
    "totalPage": 5, // 文件总页数
    "width": 595, // 文件页宽 (A4)
    "height": 842 // 文件页高 (A4)
  }
}
									

{
  "code": "FILE_UPLOAD_ERROR", // 示例
  "msg": "文件上传失败",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/uploadAttachmentFile' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-F 'file=@/path/to/your/attachment.zip'
									

{
  "code": "200",
  "msg": "成功",
  "data": { // 附件文件上传结果
    "fileName": "attachment.zip",
    "fileUrl": "group1/M00/00/03/...", // 实际存储路径
    "totalPage": 0 // 附件文件通常不计页数
  }
}
									

{
  "code": "FILE_UPLOAD_ERROR", // 示例
  "msg": "附件上传失败",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/addTemplate' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateName": "标准租赁合同模板",
  "encryptFlag": 1,
  "participantList": [
    {
      "participantFlag": "出租方(甲方)",
      "participantType": 1,
      "participateBizType": ["2"],
      "participantSetMode": 3, // 发起人本人
      "psnAccount": null,
      "psnName": null,
      "draftSort": 1,
      "signOrder": 1,
      "participantCorpName": "我的公司" // 假设发起方是企业
    },
    {
      "participantFlag": "承租方(乙方)",
      "participantType": 2,
      "participateBizType": ["1", "2"], // 需要填写和签署
      "participantSetMode": 0, // 模板指定 (发起时传入)
      "psnAccount": null,
      "psnName": null,
      "draftSort": 2,
      "signOrder": 2
    }
  ],
  "contractFileList": [
    {
      "fileName": "contract_template.pdf",
      "fileUrl": "group1/M00/00/02/...",
      "totalPage": 5,
      "width": 595,
      "height": 842
    }
  ],
  "attachmentList": [
    {
      "fileName": "attachment.zip",
      "fileUrl": "group1/M00/00/03/..."
    }
  ]
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": { // 模板实体类 (返回创建的模板信息)
    "templateId": 1001,
    "corpName": "示例有限公司",
    "templateCode": "TPL20240125001",
    "templateName": "标准租赁合同模板",
    "templateStatus": 1, // 默认启用
    // ... 其他模板信息
    "contractFileList": [ // 包含文件信息
        { "fileId": 2001, "fileName": "contract_template.pdf", ... }
    ],
    "participantList": [ // 包含参与方信息
        { "participantId": 3001, "participantFlag": "出租方(甲方)", ... },
        { "participantId": 3002, "participantFlag": "承租方(乙方)", ... }
    ],
    "componentList": [], // 控件列表此时为空
    "copierList": [],
    "attachmentList": [ // 包含附件信息
        { "attachmentId": 4001, "fileName": "attachment.zip", ... }
    ]
  }
}
									

{
  "code": "TEMPLATE_NAME_EXIST", // 示例
  "msg": "模板名称已存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/modifyTemplate' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001,
  "templateName": "标准租赁合同模板 V2.0", // 修改名称
  "encryptFlag": 1,
  "participantList": [ // 需要传入完整的列表，包含 ID
    {
      "participantId": 3001,
      "participantFlag": "出租方(甲方)",
      "participantType": 1,
      "participateBizType": ["2"],
      "participantSetMode": 3,
      "psnAccount": null,
      "psnName": null,
      "draftSort": 1,
      "signOrder": 1,
      "participantCorpName": "我的公司"
    },
    {
      "participantId": 3002,
      "participantFlag": "承租方(乙方)",
      "participantType": 2,
      "participateBizType": ["1", "2"],
      "participantSetMode": 0,
      "psnAccount": null,
      "psnName": null,
      "draftSort": 2,
      "signOrder": 2
    }
  ],
  "contractFileList": [ // 需要传入完整的列表，包含 ID
    {
      "fileId": 2001,
      "fileName": "contract_template.pdf",
      "fileUrl": "group1/M00/00/02/...",
      "totalPage": 5,
      "width": 595,
      "height": 842
    }
  ],
  "attachmentList": [] // 假设移除了附件
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": { // 返回更新后的模板实体类
    "templateId": 1001,
    "templateName": "标准租赁合同模板 V2.0",
    // ... 其他更新后的信息
  }
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在或无权限修改",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/addComponent' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001,
  "components": [
    {
      "participantId": 3002, // 承租方
      "contractFileId": 2001, // 合同文件ID
      "componentName": "承租方姓名",
      "componentType": 1, // 单行文本
      "required": 1,
      "positionX": 100.5,
      "positionY": 200.0,
      "pageNum": 1,
      "specialAttribute": { "maxLength": "10", "font": "SimSun", "fontSize": 12 }
    },
    {
      "participantId": 3001, // 出租方
      "contractFileId": 2001,
      "componentName": "出租方签章区",
      "componentType": 6, // 签章区
      "required": 1,
      "positionX": 400.0,
      "positionY": 700.0,
      "pageNum": 5,
      "specialAttribute": { "width": 150, "height": 60, "showSignDate": 1, "signStyle": 1 }
    }
  ]
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": {} // 通常不返回特定数据
}
									

{
  "code": "COMPONENT_ADD_FAILED", // 示例
  "msg": "添加控件失败，请检查参数",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/modifyComponent' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001,
  "components": [
    {
      "componentId": 5001, // 假设这是 "承租方姓名" 控件的 ID
      "participantId": 3002,
      "contractFileId": 2001,
      "componentName": "承租方姓名(必填)", // 修改名称
      "componentType": 1,
      "required": 1,
      "positionX": 100.5,
      "positionY": 200.0, // 假设位置不变
      "pageNum": 1,
      "specialAttribute": { "maxLength": "10", "font": "SimHei", "fontSize": 12 } // 修改字体
    },
    {
      "componentId": 5002, // 假设这是 "出租方签章区" 控件的 ID
      "participantId": 3001,
      "contractFileId": 2001,
      "componentName": "出租方盖章处", // 修改名称
      "componentType": 6,
      "required": 1,
      "positionX": 400.0,
      "positionY": 700.0,
      "pageNum": 5,
      "specialAttribute": { "width": 160, "height": 60, "showSignDate": 0, "signStyle": 1 } // 修改宽度和日期显示
    }
    // 如果有控件要删除，则不在此列表中包含
  ]
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": {}
}
									

{
  "code": "COMPONENT_UPDATE_FAILED", // 示例
  "msg": "更新控件失败，请检查控件ID是否存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/componentInfoList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": [ // 合同文件查询参数类列表 (每个文件及其控件)
    {
      "corpId": 12345,
      "templateId": 1001,
      "fileId": 2001,
      "fileName": "contract_template.pdf",
      "totalPage": 5,
      "width": 595,
      "height": 842,
      "jpgUrlList": ["url1.jpg", "url2.jpg", ...], // 文件预览图
      "participantList": [ // 模板定义的参与方信息
        { "participantId": 3001, "participantFlag": "出租方(甲方)", ... },
        { "participantId": 3002, "participantFlag": "承租方(乙方)", ... }
      ],
      "componentList": [ // 该文件上的控件列表
        {
          "componentId": 5001,
          "templateId": 1001,
          "participantId": 3002,
          "contractFileId": 2001,
          "componentKey": null,
          "componentName": "承租方姓名(必填)",
          "componentType": 1,
          "value": null, // 默认值
          "required": 1,
          "positionX": 100.5,
          "positionY": 200.0,
          "pageNum": 1,
          "specialAttribute": { "maxLength": "10", "font": "SimHei", "fontSize": 12, ... }
        },
        {
          "componentId": 5002,
          "templateId": 1001,
          "participantId": 3001,
          "contractFileId": 2001,
          "componentKey": null,
          "componentName": "出租方盖章处",
          "componentType": 6,
          "value": null,
          "required": 1,
          "positionX": 400.0,
          "positionY": 700.0,
          "pageNum": 5,
          "specialAttribute": { "width": 160, "height": 60, "showSignDate": 0, "signStyle": 1, ... }
        }
        // ... 其他控件
      ]
    }
    // 如果模板有多个文件，这里会有多个对象
  ]
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/list' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateStatus": 1,
  "listPageNo": 1,
  "listPageSize": 5
}'
									

{
  "code": "200",
  "msg": "成功",
  "listPageNo": 1,
  "countInPage": 1,
  "listPageCount": 1,
  "totalCount": 1,
  "data": [ // 模板实体类列表
    {
      "templateId": 1001,
      "templateCode": "TPL20240125001",
      "templateName": "标准租赁合同模板 V2.0",
      "templateStatus": 1,
      "corpName": "示例有限公司",
      "encryptFlag": 1,
      "createTime": "2024-01-25T10:00:00.000+0800",
      "updateTime": "2024-01-25T11:30:00.000+0800",
      "createName": "张三",
      "updateName": "李四"
    }
    // ... 其他模板
  ]
}
									

{
  "code": "QUERY_ERROR", // 示例
  "msg": "查询模板列表失败",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/info' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001,
  "templateType": "2"
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": { // 模板详细信息实体类
    "templateId": 1001,
    "corpName": "示例有限公司",
    "templateCode": "TPL20240125001",
    "templateName": "标准租赁合同模板 V2.0",
    "templateStatus": 1,
    "encryptFlag": 1,
    "createTime": "2024-01-25T10:00:00.000+0800",
    "updateTime": "2024-01-25T11:30:00.000+0800",
    "createName": "张三",
    "updateName": "李四",
    "contractFileList": [ // 合同文件列表
      {
        "fileId": 2001,
        "templateId": 1001,
        "fileName": "contract_template.pdf",
        "fileUrl": "group1/M00/00/02/...",
        "totalPage": 5,
        "width": 595,
        "height": 842
      }
    ],
    "participantList": [ // 参与方列表
      {
        "participantId": 3001,
        "templateId": 1001,
        "participantFlag": "出租方(甲方)",
        "participantType": 1,
        "participateBizType": ["2"],
        "participantSetMode": 3,
        // ... 其他参与方信息
      },
      {
        "participantId": 3002,
        "templateId": 1001,
        "participantFlag": "承租方(乙方)",
        "participantType": 2,
        "participateBizType": ["1", "2"],
        "participantSetMode": 0,
        // ... 其他参与方信息
      }
    ],
    "copierList": [], // 抄送方列表
    "attachmentList": [] // 附件列表
  }
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/updateStatus' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001,
  "templateStatus": 0 // 停用模板
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": {}
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/del' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": {}
}
									

{
  "code": "TEMPLATE_DELETE_FAILED", // 示例
  "msg": "模板正在使用中，无法删除",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/getTemplateManageUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{}'
									

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/embed/template/manage?session=temp_token" // 返回的管理页面URL
}
									

{
  "code": "URL_GEN_FAILED", // 示例
  "msg": "生成管理链接失败",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/getTemplateSettingUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/embed/template/setting/1001?session=temp_token" // 返回的设置页面URL
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在",
  "data": null
}
									

curl -X POST 'https://your-api-host.com/template/getTemplateEditeUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-d '{
  "templateId": 1001
}'
									

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/embed/template/edit/1001?session=temp_token" // 返回的编辑页面URL
}
									

{
  "code": "TEMPLATE_NOT_FOUND", // 示例
  "msg": "模板不存在",
  "data": null
}