开放文档API

curl -X POST 'https://your-api-host.com/signTask/myContract/listCount' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "docQueryType": 4
}'
                                 

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

# 注意：导出接口通常需要设置 Accept 头，并处理文件流响应
curl -X POST 'https://your-api-host.com/signTask/contract/export' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-H 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
-d '{
  "docQueryType": 6
}' --output contracts_export.xlsx
                                

curl -X POST 'https://your-api-host.com/signTask/enterpriseContracts/list' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: ADMIN_ACCESS_TOKEN' \
-H 'userId: ADMIN_USER_ID' \
-H 'openCorpId: TARGET_CORP_ID' \
-H 'source: pc' \
-d '{
  "flowStatus": 3,
  "listPageNo": 1,
  "listPageSize": 10
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": [
    { // 流程信息实体类
       "flowId": 1005,
       "corpName": "目标企业", // 发起方企业名
       "flowCode": "FL20240301001",
       "flowTitle": "年度采购协议",
       "flowStatus": 3, // 已完成
       "initiatorName": "管理员A",
       // ... 其他 流程信息实体类 字段
    }
    // ... more contracts
  ],
  "listPageNo": 1,
  "countInPage": 1,
  "listPageCount": 5,
  "totalCount": 45
}
                                  

curl -X POST 'https://your-api-host.com/signTask/enterpriseContracts/enterpriseContractsCount' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: ADMIN_ACCESS_TOKEN' \
-H 'userId: ADMIN_USER_ID' \
-H 'openCorpId: TARGET_CORP_ID' \
-H 'source: pc' \
-d '{
  "flowStatus": 3
}'
                                

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

# 注意：导出接口通常需要设置 Accept 头，并处理文件流响应
curl -X POST 'https://your-api-host.com/signTask/enterpriseContracts/export' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: ADMIN_ACCESS_TOKEN' \
-H 'userId: ADMIN_USER_ID' \
-H 'openCorpId: TARGET_CORP_ID' \
-H 'source: pc' \
-H 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' \
-d '{
  "flowStatus": 3
}' --output enterprise_contracts_export.xlsx
                                 

curl -X POST 'https://your-api-host.com/signTask/contract/listByMobile' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: OPERATOR_USER_ID' \
-H 'source: pc' \
-d '{
  "mobile": "13800138000",
  "flowStatus": 3, // 查询已完成的
  "listPageNo": 1,
  "listPageSize": 20
}'
                                

{
  "code": "200",
  "msg": "成功",
  "data": [
    {
       "flowId": 1002,
       "corpName": "对方公司",
       "flowCode": "FL20240102001",
       "flowTitle": "采购合同",
       "flowStatus": 3, // 已完成
       // ... 其他 流程信息实体类 字段
    }
  ],
  "listPageNo": 1,
  "countInPage": 1,
  "listPageCount": 1,
  "totalCount": 1
}
                                 

curl -X POST 'https://your-api-host.com/signTask/contract/info' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                

{
  "code": "200",
  "msg": "成功",
  "data": [
    {
      "flowId": 1001,
      "fileId": 5001,
      "fileName": "服务合同文档.pdf",
      "fileUrl": "...",
      "filePath": "...",
      "totalPage": 5,
      "width": 595,
      "height": 842,
      "componentList": [ // 参考 组件信息实体类
        {
          "componentId": 3001,
          "componentKey": "甲方名称",
          "componentType": 1, // 单行文本
          "participantId": 4001, // 分配给参与方
          "value": "示例公司",
          // ... 其他字段
        },
        {
           "componentId": 3002,
           "componentKey": "甲方签章",
           "componentType": 6, // 签章区域
           "participantId": 4001,
           "pageNum": 5,
           "positionX": 100.5,
           "positionY": 700.2,
           // ... 其他字段
        }
      ],
      "participantList": [ // 参考 参与方实体类_1
         {
            "participantId": 4001,
            "participantFlag": "甲方",
            "participantType": 1, // 企业
            "participateBizType": ["1", "2"], // 填写和签署
            "psnName": "张三",
            "participantCorpName": "示例公司",
            // ... 其他字段
         },
         {
             "participantId": 4002,
             "participantFlag": "乙方",
             "participantType": 0, // 个人
             "participateBizType": ["2"], // 仅签署
             "psnName": "李四",
             // ... 其他字段
         }
      ],
      "jpgUrlList": ["...", "...", "..."], // 文件预览图片
      "attachmentList": [ // 参考 附属文件实体类_1
         {
            "attachmentId": 6001,
            "fileName": "附件1.docx",
            "fileUrl": "...",
            "signerUpload": 0
         }
      ]
    }
  ]
}
                                 

curl -X POST 'https://your-api-host.com/signTask/contract/taskInfo' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                

{
  "code": "200",
  "msg": "成功",
  "data": { // 签署任务信息
    "flowId": 1001,
    "flowTitle": "服务合同",
    "expireDate": "2024-12-31T23:59:59.000+0800",
    "flowStatus": 2, // 签署中
    "flowDesc": "年度服务协议",
    "flowStartTime": "2024-01-01T10:00:00.000+0800",
    "flowFinishTime": null,
    "operateStatus": 2,
    "corpId": 3001,
    "corpName": "示例公司",
    "initiatorId": "20001",
    "initiatorName": "张三",
    "initiatorType": 1,
    "templateId": null,
    "encryptFlag": 0,
    "reversePayFlag": 0,
    "feePayFlag": 1,
    "payeeContractFlag": 0,
    "totalAmount": null,
    "createTime": "2024-01-01T09:58:00.000+0800",
    "participantList": [ // 参考 签署人信息
      {
        "participantId": 4001,
        "psnId": 20001,
        "psnName": "张三",
        "participantCorpName": "示例公司",
        "participantType": 1,
        "participateBizType": "1,2",
        "signStatus": 3, // 已签署
        "draftSort": 1,
        "signOrder": 1,
        "dongStatus": "did",
        "draftTime": "2024-01-01T10:05:00.000+0800",
        "signTime": "2024-01-01T10:10:00.000+0800"
        // ... payee, waitForMeToDo 等字段
      },
      {
         "participantId": 4002,
         "psnId": 20002,
         "psnName": "李四",
         "participantCorpName": null,
         "participantType": 0, // 个人
         "participateBizType": "2",
         "signStatus": 2, // 签署中 (轮到他)
         "draftSort": 1, // 假设并行填写
         "signOrder": 2, // 顺序签署
         "dongStatus": "do",
         "draftTime": null, // 未填写
         "signTime": null // 未签署
         // ... payee, waitForMeToDo 等字段
      }
    ],
    "contractFileList": [ // 参考 合同文件实体类_2
       {
          "id": 5001,
          "flowId": 1001,
          "fileName": "服务合同文档.pdf",
          // ... 其他字段
       }
    ]
  }
}
                                 

curl -X POST 'https://your-api-host.com/signTask/fillComponentList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: PARTICIPANT_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                 

{
  "code": "200",
  "msg": "成功",
  "data": [
    {
      "flowId": 1001,
      "fileId": 5001,
      "fileName": "服务合同文档.pdf",
      // ... 文件信息 ...
      "componentList": [ // 只包含文本、数字、日期等可填写组件
        {
          "componentId": 3001,
          "componentKey": "甲方名称",
          "componentType": 1, // 单行文本
          "participantId": 4001,
          "required": 1, // 必填
          "value": "示例公司", // 已填写的值
          // ... 其他字段
        },
         {
          "componentId": 3003,
          "componentKey": "服务期限",
          "componentType": 3, // 日期
          "participantId": 4002, // 可能由另一方填写
          "required": 1,
          "value": "2024-12-31", // 已填写的值
          // ... 其他字段
        }
        // 不包含签章区等非填写组件
      ],
      "participantList": [ /* ... */ ],
      "jpgUrlList": [ /* ... */ ],
      "attachmentList": [ /* ... */ ]
    }
  ]
}
                                 

curl -X POST 'https://your-api-host.com/signTask/signComponentList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: PARTICIPANT_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                 

{
  "code": "200",
  "msg": "成功",
  "data": [
    {
      "flowId": 1001,
      "fileId": 5001,
      "fileName": "服务合同文档.pdf",
      // ... 文件信息 ...
      "componentList": [ // 只包含签章区组件
        {
           "componentId": 3002,
           "componentKey": "甲方签章",
           "componentType": 6, // 签章区域
           "participantId": 4001,
           "pageNum": 5,
           "positionX": 100.5,
           "positionY": 700.2,
           "width": 100,
           "height": 50,
           "required": 1,
           "value": null, // 签章区通常无值，或表示是否已盖章
           // ... 其他字段
        },
        {
           "componentId": 3004,
           "componentKey": "乙方签名",
           "componentType": 6, // 签章区域
           "participantId": 4002,
           "pageNum": 5,
           "positionX": 300.5,
           "positionY": 700.2,
           "width": 100,
           "height": 50,
           "required": 1,
           "value": null,
           // ... 其他字段
        }
      ],
      "participantList": [ /* ... */ ],
      "jpgUrlList": [ /* ... */ ],
      "attachmentList": [ /* ... */ ]
    }
  ]
}
                                  

curl -X POST 'https://your-api-host.com/signTask/signFlowContractFile/list' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                

{
  "code": "200",
  "msg": "成功",
  "data": [
    {
      "fileId": 5001,
      "flowId": 1001,
      "fileCode": "CONTR20240101A",
      "fileName": "服务合同文档.pdf",
      "fileUrl": "..."
    },
    { // 如果流程中有多个文件
      "fileId": 5002,
      "flowId": 1001,
      "fileCode": "CONTR20240101B",
      "fileName": "保密协议.pdf",
      "fileUrl": "..."
    }
  ]
}
                                 

curl -X POST 'https://your-api-host.com/signTask/signFlowContractFile/info' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "fileId": 5001
}'
                                 

{
  "code": "200",
  "msg": "成功",
  "data": {
    "fileId": 5001,
    "flowId": 1001,
    "fileCode": "CONTR20240101A",
    "fileName": "服务合同文档.pdf",
    "fileUrl": "..."
  }
}
                                 

curl -X POST 'https://your-api-host.com/signTask/signFlowContractFile/componentInfoList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "fileId": 5001
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": [
    { // 合同文件查询参数类
      "fileName": "服务合同文档.pdf",
      "fileUrl": "...",
      "filePath": "...",
      "totalPage": 5,
      "width": 595,
      "height": 842,
      "componentList": [ // 参考 模板组件实体类
        {
          "componentId": 3001,
          "componentKey": "甲方名称",
          "componentType": 1,
          "participantId": 4001,
          "pageNum": 1,
          "positionX": 50.0,
          "positionY": 100.0,
          "required": 1,
          "value": "示例公司", // 默认值或已填值
          "specialAttribute": { // 参考 TemplateCompSpecialAttr
             "font": "SimSun",
             "fontSize": 12
          }
          // ...
        },
         {
           "componentId": 3002,
           "componentKey": "甲方签章",
           "componentType": 6,
           "participantId": 4001,
           "pageNum": 5,
           // ...
        }
      ],
      "participantList": [ // 参考 参与方信息
         {
            "participantId": 4001,
            "participantFlag": "甲方",
            "participantType": 1,
            "psnName": "张三",
            "participantCorpName": "示例公司"
            // ...
         },
         {
            "participantId": 4002,
            "participantFlag": "乙方",
            "participantType": 0,
            "psnName": "李四"
             // ...
         }
      ],
      "jpgUrlList": [ // 文件预览图片
        "preview_page1.jpg",
        "preview_page2.jpg",
        // ...
      ],
      "corpId": 3001, // 关联的企业ID
      "templateId": null // 如果来自模板则有值
    }
  ]
}
                                  

curl -X POST 'https://your-api-host.com/signTask/signerFlowCoverInfo' \
-H 'Content-Type: application/json' \
# 可能不需要认证 Header，或使用特定分享 Header
-d '{
  "flowId": "SHORTCODE123ABC"
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": { // 合同信息 (封面)
    "flowId": 1001, // 内部流程ID
    "corpId": 3001,
    "corpName": "示例公司",
    "flowTitle": "服务合同",
    "flowStatus": 2, // 签署中
    "flowDesc": "年度服务协议",
    "operateStatus": null, // 可能对当前访问者无意义
    "initiatorType": 1,
    "initiatorId": 20001,
    "initiatorName": "张三",
    "directFlag": 0,
    "encryptFlag": 0,
    "reversePayFlag": 0,
    "feePayFlag": 1,
    "payeeContractFlag": 0,
    "signerList": [ // 参与者列表, 参考 签署人信息_1
      {
        "participantId": 4001,
        "participantFlag": "甲方",
        "signStatus": 3, // 已签署
        "participantCorpName": "示例公司",
        "participantType": 1,
        "psnName": "张三"
        // 可能包含 payee (支付信息摘要)
      },
      {
        "participantId": 4002,
        "participantFlag": "乙方",
        "signStatus": 2, // 签署中
        "participantCorpName": null,
        "participantType": 0,
        "psnName": "李四"
      }
    ],
    "currentUserMobile": null, // 当前访问者手机（如果能识别）
    "memberIdent": null, // 当前访问者实名状态
    "corpIdent": null, // 当前访问者企业实名状态
    "accountBalance": null // 余额信息通常不在此暴露
  }
}
                                  

curl -X POST 'https://your-api-host.com/signTask/fetchSignerByShortCode' \
-H 'Content-Type: application/json' \
# 可能需要特定认证
-d '{
  "flowId": "SHORTCODE123ABC"
}'
                                 

{
  "code": "200",
  "msg": "成功",
  "data": {
    "participant_4001": { // Key 可能是 participantId
      "name": "张三",
      "mobile": "13800138000",
      "type": 1, // 企业
      "corpName": "示例公司"
    },
     "participant_4002": {
       "name": "李四",
       "mobile": "13900139000",
       "type": 0 // 个人
    }
    // ...
  }
}
                                 

curl -X POST 'https://your-api-host.com/signTask/attachmentFileInfo' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "attachmentId": 6001
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": { // 附属文件实体类
    "attachmentId": 6001,
    "flowId": 1001,
    "fileName": "附件1.docx",
    "signerUpload": 0,
    "totalPage": 3, // 文件页数
    "fileUrl": "...",
    "jpgUrlList": [ // 预览图片地址
      "attach_6001_page1.jpg",
      "attach_6001_page2.jpg",
      "attach_6001_page3.jpg"
    ],
    "createTime": "2024-01-01T09:58:00.000+0800",
    "createBy": "张三"
  }
}
                                  

curl -X POST 'https://your-api-host.com/signTask/info' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": { // 流程信息实体类
    "flowId": 1001,
    "corpName": "示例公司",
    "flowCode": "FL20240101001",
    "flowTitle": "服务合同",
    "flowStatus": 2,
    "flowDesc": "年度服务协议",
    "operateStatus": 2,
    "initiatorType": 1,
    "initiatorId": 20001,
    "initiatorName": "张三",
    // ... 其他流程信息字段 ...
    "contractFileList": [ // 参考 合同文件实体类
      {
        "fileId": 5001,
        "flowId": 1001,
        "fileName": "服务合同文档.pdf",
        // ...
      }
    ],
    "participantList": [ // 参考 签署人信息
      {
        "participantId": 4001,
        "psnName": "张三",
        "signStatus": 3,
        // ...
      },
      {
        "participantId": 4002,
        "psnName": "李四",
        "signStatus": 2,
        // ...
      }
    ]
  }
}
                                  

curl -X POST 'https://your-api-host.com/signTask/signerPayInfo' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: PAYER_ACCESS_TOKEN' \
-H 'userId: PAYER_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1003 // 假设 1003 是一个收款合同
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": { // 签署人支付信息_1
    "flowId": 1003,
    "participantId": 4005, // 当前付款方的 participantId
    "flowTitle": "咨询服务费支付合同",
    "psnId": 20004, // 收款方经办人ID
    "psnName": "赵六", // 收款方经办人名称
    "participantCorpId": 3002, // 收款方企业ID
    "participantCorpName": "咨询公司", // 收款方企业名称
    "psnAccount": "13700137000", // 收款方经办人手机
    "amount": 5000.00, // 需要支付的金额
    "remark": "第一期咨询费", // 付款备注
    "payChannelList": [ // 可用支付渠道, 参考 支付渠道基本信息
      {
        "id": 1,
        "corpId": 3002,
        "providerCode": "alipay",
        "providerName": "支付宝",
        "payTypeCode": "PC", // 支付方式
        "appId": "ALIPAY_APP_ID" // 支付宝 App ID
      },
      {
         "id": 2,
         "corpId": 3002,
         "providerCode": "wxpay",
         "providerName": "微信支付",
         "payTypeCode": "NATIVE", // Native 扫码
         "appId": "WXPAY_APP_ID"
      }
    ]
  }
}
                                   

# 注意：下载接口通常需要处理文件流响应
curl -X POST 'https://your-api-host.com/signTask/downFiles' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-H 'source: pc' \
-d '{
  "fileId": 5001
}' --output downloaded_contract.pdf
                                  

curl -X POST 'https://your-api-host.com/signTask/getMyActivitiesUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: USER_ACCESS_TOKEN' \
-H 'userId: USER_ID' \
-H 'source: pc' \
-d '{}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/my-contracts?user_token=SESSION_TOKEN_FOR_USER_ID"
}
                                  

curl -X POST 'https://your-api-host.com/signTask/getEnterpriseContractUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: ADMIN_ACCESS_TOKEN' \
-H 'userId: ADMIN_USER_ID' \
-H 'openCorpId: TARGET_CORP_ID' \
-H 'source: pc' \
-d '{}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/enterprise/contracts?corp_id=TARGET_CORP_ID&admin_token=SESSION_TOKEN_FOR_ADMIN"
}
                                  

curl -X POST 'https://your-api-host.com/signTask/getViewUrl' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: VIEWER_ACCESS_TOKEN' \
-H 'userId: VIEWER_USER_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1001
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": "https://your-system-url.com/contract/view/1001?view_token=TEMP_VIEW_TOKEN"
}
                                  

curl -X POST 'https://your-api-host.com/signTask/enterpriseContracts/info' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: ADMIN_ACCESS_TOKEN' \
-H 'userId: ADMIN_USER_ID' \
-H 'openCorpId: TARGET_CORP_ID' \
-H 'source: pc' \
-d '{
  "flowId": 1005
}'
                                  

{
  "code": "200",
  "msg": "成功",
  "data": { // 流程信息实体类
    "flowId": 1005,
    "corpName": "目标企业",
    "flowCode": "FL20240301001",
    "flowTitle": "年度采购协议",
    "flowStatus": 3,
    "flowDesc": "...",
    "initiatorName": "管理员A",
    // ... 其他流程信息字段 ...
    "contractFileList": [ /* ... */ ],
    "participantList": [ /* ... */ ]
  }
}