API概览
模板与文件相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeFlowTemplates | 查询模板 | 300 |
UploadFiles | 多文件上传 | 300 |
CreateConvertTaskApi | 创建文件转换任务 | 300 |
GetTaskResultApi | 查询转换任务状态 | 300 |
DescribeFileUrls | 查询文件下载URL | 300 |
创建签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateFlowByFiles | 用PDF文件创建签署流程 | 300 |
CreateFlow | 模板发起合同-创建签署流程 | 300 |
CreateDocument | 模板发起合同-创建电子文档 | 300 |
StartFlow | 模板发起合同-发起签署流程 | 300 |
CreatePrepareFlow | 通过页面快速发起签署流程 | 20 |
CreateSchemeUrl | 获取小程序签署链接 | 300 |
CreateFlowSignUrl | 创建个人用户H5签署链接 | 20 |
CreateMultiFlowSignQRCode | 创建一码多扫流程签署二维码 | 300 |
查询签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeFlowBriefs | 查询流程摘要 | 300 |
DescribeFlowInfo | 查询合同详情 | 20 |
控制签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateFlowSignReview | 提交企业签署流程审批结果 | 300 |
CreateFlowApprovers | 补充签署流程本企业签署人信息 | 20 |
CreateFlowReminds | 合同催办 | 20 |
CreateReleaseFlow | 发起解除协议 | 20 |
CancelFlow | 撤销单个签署流程 | 300 |
CreateBatchCancelFlowUrl | 批量撤销签署流程 | 300 |
CancelMultiFlowSignQRCode | 取消一码多扫二维码 | 300 |
电子印章管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeOrganizationSeals | 查询企业电子印章 | 20 |
CreateSealPolicy | 创建印章授权 | 20 |
DeleteSealPolicies | 撤销印章授权 | 20 |
CreatePreparedPersonalEsign | 创建导入处方单个人印章 | 20 |
证书管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
VerifyPdf | 流程文件验签 | 20 |
CreateFlowEvidenceReport | 创建并返回出证报告 | 20 |
DescribeFlowEvidenceReport | 查询出证报告 | 20 |
机构与员工相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeIntegrationEmployees | 查询企业员工列表 | 20 |
CreateIntegrationEmployees | 创建企业员工 | 20 |
UpdateIntegrationEmployees | 更新企业员工信息 | 20 |
DeleteIntegrationEmployees | 移除企业员工 | 20 |
BindEmployeeUserIdWithClientOpenId | 员工userid与客户系统openid绑定 | 20 |
UnbindEmployeeUserIdWithClientOpenId | 员工userid与客户系统openid解绑 | 20 |
DescribeOrganizationGroupOrganizations | 查询集团企业列表 | 20 |
DescribeIntegrationMainOrganizationUser | 查询集团主企业员工账号 | 20 |
CreateChannelSubOrganizationModifyQrCode | 生成子客编辑企业信息二维码 | 20 |
ModifyApplicationCallbackInfo | 修改企业回调配置 | 20 |
角色管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeIntegrationRoles | 查询企业角色列表 | 20 |
CreateIntegrationUserRoles | 绑定员工角色 | 20 |
DeleteIntegrationRoleUsers | 解绑员工角色 | 20 |
个人帐号管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeUserAutoSignStatus | 查询个人用户开通自动签状态 | 20 |
CreateUserAutoSignEnableUrl | 获取个人用户自动签开启链接 | 20 |
DisableUserAutoSign | 关闭个人自动签功能 | 20 |
DescribeThirdPartyAuthCode | 通过AuthCode查询用户是否实名 | 20 |