API概览
帐号管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateConsoleLoginUrl | 生成控制台、移动端链接 | 20 |
ChannelDescribeEmployees | 查询企业员工 | 20 |
SyncProxyOrganization | 同步企业信息 | 20 |
SyncProxyOrganizationOperators | 同步企业经办人列表 | 20 |
ChannelDescribeRoles | 查询用户角色 | 20 |
ChannelCreateUserRoles | 绑定员工角色 | 20 |
ChannelDeleteRoleUsers | 删除员工绑定角色 | 20 |
文档模板相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeTemplates | 查询模板信息列表 | 20 |
OperateChannelTemplate | 操作第三方应用平台企业模板 | 20 |
ChannelCreateMultiFlowSignQRCode | 创建一码多扫签署流程二维码 | 20 |
ChannelCancelMultiFlowSignQRCode | 取消一码多扫二维码 | 20 |
文件上传下载相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
UploadFiles | 文件上传 | 20 |
ChannelGetTaskResultApi | 查询转换任务状态 | 20 |
ChannelCreateConvertTaskApi | 创建文件转换任务 | 20 |
流程发起相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateFlowsByTemplates | 使用模板创建签署流程 | 20 |
ChannelCreateFlowByFiles | 通过文件创建签署流程 | 20 |
ChannelCreateFlowGroupByFiles | 通过多文件创建合同组签署流程 | 20 |
ChannelCreateReleaseFlow | 发起解除协议 | 20 |
PrepareFlows | 准备待发起文件 | 20 |
流程签署相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateSignUrls | 获取跳转小程序查看或签署链接 | 20 |
ChannelCreateFlowSignReview | 提交企业签署流程审批结果 | 20 |
ChannelCancelFlow | 撤销签署流程 | 20 |
ChannelBatchCancelFlows | 根据签署流程id批量撤销合同 | 20 |
ChannelCreateBatchCancelFlowUrl | 根据签署流程id创建批量撤销url | 20 |
流程管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeUsage | 合同用量查询 | 20 |
GetDownloadFlowUrl | 获取合同(流程)批量下载链接 | 20 |
DescribeResourceUrlsByFlows | 根据签署流程信息批量获取资源下载链接 | 20 |
ChannelCreateFlowReminds | 合同催办 | 20 |
ChannelCreateBoundFlows | 领取未归属的合同 | 20 |
DescribeFlowDetailInfo | 查询合同(签署流程)的详细信息 | 20 |
可嵌入页面相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
ChannelCreatePrepareFlow | 获取模板发起合同web页面 | 20 |
ChannelCreateEmbedWebUrl | 获取常规模块web页面 | 20 |
ChannelCreateFlowSignUrl | 获取个人签署H5页面 | 20 |
证书管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
ChannelVerifyPdf | 流程文件验签 | 20 |
CreateChannelFlowEvidenceReport | 创建并返回出证报告 | 20 |
DescribeChannelFlowEvidenceReport | 查询出证报告 | 20 |
印章管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
ChannelDescribeOrganizationSeals | 查询子客企业电子印章 | 20 |
ChannelCreateSealPolicy | 创建印章授权 | 20 |
ChannelUpdateSealStatus | 更新印章状态 | 20 |
ChannelDeleteSealPolicies | 删除印章授权 | 20 |
CreateSealByImage | 通过图片为子客企业代创建印章 | 20 |
企业及个人相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeExtendedServiceAuthInfo | 查询企业扩展服务授权信息 | 20 |
ModifyExtendedService | 修改企业扩展服务 | 20 |