帮助中心 / 开放平台帮助文档 / 接口列表
开放平台接口列表说明
接口列表
说明
以下列表包含开放平台所涉及的所有接口，点击文档可查看接口的具体说明、请求参数、返回参数、错误码以及请求示例等。
调用地址：
测试环境：https://openapi.qiyuesuo.cn
正式环境：https://openapi.qiyuesuo.com
接口协议
合同管理
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 创建合同草稿 |
/v2/contract/draft |
POST |
查看文档 |
| 用文件添加合同文档 |
/v2/document/addbyfile |
POST |
查看文档 |
| 用模板添加合同文档 |
/v2/document/addbytemplate |
POST |
查看文档 |
| 发起合同 |
/v2/contract/send |
POST |
查看文档 |
| 抄送合同 |
/v2/contract/copysend |
POST |
查看文档 |
| 修改签署方 |
/v3/signatory/edit |
POST |
查看文档 |
| 添加签署方 |
/v2/signatory/add |
POST |
查看文档 |
| 强制结束合同 |
/v2/contract/forceend |
POST |
查看文档 |
| 上传强制结束附件 |
/v2/contract/forceend/addattachment |
POST |
查看文档 |
| 浏览页面 |
/v2/contract/viewurl |
GET |
查看文档 |
| 合同详情 |
/v2/contract/detail |
GET |
查看文档 |
| 获取合同列表 |
/v2/contract/list |
GET |
查看文档 |
| 下载合同与附属文件 |
/v2/contract/download |
GET |
查看文档 |
| 下载合同文档 |
/v2/document/download |
GET |
查看文档 |
| 下载合同附件 |
/v2/attachment/download |
GET |
查看文档 |
| 多文件添加合同文档 |
/v2/document/addbyfiles |
POST |
查看文档 |
| 合同文档添加水印 |
/v2/contract/addwartermark |
POST |
查看文档 |
| 合同延期 |
/v2/contract/delay |
POST |
查看文档 |
| 获取合同操作记录 |
/v2/contract/stream |
GET |
查看文档 |
| 获取合同与附属文件下载链接 |
/v2/contract/downloadurl |
GET |
查看文档 |
| 查询文件必填项填写详情 |
/v2/contract/required/detail |
POST |
查看文档 |
| 修改合同 |
/v2/contract/contractModify |
POST |
查看文档 |
| 修改签署节点签署人 |
/v2/signatory/operators/edit |
POST |
查看文档 |
| 重新发起合同 |
/v2/contract/resend |
POST |
查看文档 |
签署服务
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 签署公章 |
/v2/contract/companysign |
POST |
查看文档 |
| 签署法人章 |
/v2/contract/legalpersonsign |
POST |
查看文档 |
| 审批 |
/v2/contract/employeeaudit |
POST |
查看文档 |
| 合同催签 |
/v2/contract/notice |
POST |
查看文档 |
| 签署页面 |
/v2/contract/pageurl |
POST |
查看文档 |
| 预签署页面 |
/v2/contract/appointurl |
POST |
查看文档 |
| 获取短链接 |
/v2/contract/shorturl |
GET |
查看文档 |
| 撤回/作废合同 |
/v2/contract/invalid |
POST |
查看文档 |
| 自定义文件作废合同 |
/v2/contract/invalidbyfile |
POST |
查看文档 |
| 自定义模板文件作废合同 |
/v2/contract/invalidbytemplate |
POST |
查看文档 |
| 签署作废合同 |
/v2/contract/invalidsign |
POST |
查看文档 |
| 签署个人签名 |
/v2/contract/personalsign |
POST |
查看文档 |
| 获取签署方待加入签署链接 |
/v2/contract/joinurl |
GET |
查看文档 |
组织架构
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 公司信息 |
/v2/company/detail |
GET |
查看文档 |
| 对接方信息 |
/company/platforminfo |
GET |
查看文档 |
| 子公司列表 |
/v2/company/list |
GET |
查看文档 |
| 获取企业信息变更链接 |
/v2/company/changeinfo |
POST |
查看文档 |
| 员工列表 |
/v2/employee/list |
GET |
查看文档 |
| 添加员工 |
/v2/employee/create |
POST |
查看文档 |
| 更新员工 |
/v2/employee/update |
POST |
查看文档 |
| 移除员工 |
/v2/employee/remove |
POST |
查看文档 |
| 员工详情 |
/v2/employee/detail |
POST |
查看文档 |
| 发送子公司邀请 |
/v2/subcompany/invite |
POST |
查看文档 |
| 移除子公司 |
/v2/subcompany/remove |
GET |
查看文档 |
| 管理员工角色 |
/v2/role/manage |
POST |
查看文档 |
印章管理
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 印章列表 |
/v2/seal/list |
GET |
查看文档 |
| 印章图片 |
/v2/seal/image |
GET |
查看文档 |
| 创建印章 |
/v2/seal/autocreate |
POST |
查看文档 |
| 印章详情 |
/v2/seal/sealdetail |
GET |
查看文档 |
| 编辑印章 |
/v2/seal/edit |
POST |
查看文档 |
| 创建图片印章 |
/v2/seal/createbyimage |
POST |
查看文档 |
| 创建图片印章回调说明 |
|
|
查看文档 |
| 管理印章状态 |
/v2/seal/status |
POST |
查看文档 |
| 获取员工默认签名图片 |
/v2/seal/employeesealimage |
GET |
查看文档 |
| 删除印章 |
/v2/seal/remove |
GET |
查看文档 |
模板管理
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 模板列表 |
/v2/template/list |
GET |
查看文档 |
| 模板详情 |
/v2/template/detail |
GET |
查看文档 |
| 模板预览页面 |
/v2/template/pageurl |
GET |
查看文档 |
| 创建Word模板 |
/v3/template/createbyword |
POST |
查看文档 |
| 编辑模板 |
/v2/template/edit |
POST |
查看文档 |
| 管理模板状态 |
/v2/template/status |
POST |
查看文档 |
| 删除模板 |
/v2/template/remove |
GET |
查看文档 |
| 下载模板 |
/v2/template/download |
GET |
查看文档 |
业务分类
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 业务分类列表 |
/v2/category/list |
GET |
查看文档 |
| 业务分类详情 |
/v2/category/detail |
GET |
查看文档 |
个人认证
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 获取个人认证链接 |
/v2/personalauth |
POST |
查看文档 |
| 查询个人认证状态 |
/v2/personalauth/result |
GET |
查看文档 |
| 回调说明 |
|
|
查看文档 |
企业认证
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 获取企业认证链接 |
/companyauth/pcpage |
POST |
查看文档 |
| 获取企业认证链接（H5） |
/companyauth/h5page |
POST |
查看文档 |
| 获取企业认证链接（带营业执照） |
/companyauth/pcpagewithlicense |
POST |
查看文档 |
| 获取企业认证链接(带营业执照H5) |
/companyauth/h5pagewithlicense |
POST |
查看文档 |
| 查询认证结果 |
/companyauth/result |
GET |
查看文档 |
| 回调说明 |
|
|
查看文档 |
存证
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 数据存证 |
/v2/chain/notary |
POST |
查看文档 |
| 申请出证电子数据存证证明 |
/chain/evidence/electronic/prove/apply |
POST |
查看文档 |
| 申请出证完整版存证报告 |
/chain/evidence/complete/report/apply |
POST |
查看文档 |
| 查询完整版存证报告审核结果 |
/chain/evidence/complete/report/status |
GET |
查看文档 |
| 下载完整版存证报告 |
/chain/evidence/complete/report/download |
GET |
查看文档 |
外部客户
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 新增外部客户 |
/v2/customer/add |
POST |
查看文档 |
授权管理
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 单点登录模块授权页面 |
/v2/ssoprivilege/url |
POST |
查看文档 |
| 个人签名授权页面 |
/v2/personalsign/authurl |
POST |
查看文档 |
| 取消个人签名授权 |
/v2/personalsign/deauthorize |
POST |
查看文档 |
| 个人签名授权回调说明 |
|
|
查看文档 |
| 查询个人静默签授权记录 |
/v2/personalsign/query |
POST |
查看文档 |
费用管理
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 查询用户费用信息 |
/v2/company/fee/info |
GET |
查看文档 |
辅助工具
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 文件验签 |
/v2/verify |
POST |
查看文档 |
| 全局响应码 |
|
|
查看文档 |
信息校验
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 个人身份校验 |
/v2/identity/verify |
POST |
查看文档 |
| 企业身份校验 |
/v2/companyinfo/verify |
POST |
查看文档 |
| 身份证OCR识别 |
/v2/ocr/idcard |
POST |
查看文档 |
| 银行卡OCR识别 |
/v2/ocr/bankcard |
POST |
查看文档 |
开放平台应用
| 接口名称 |
接口地址 |
请求方式 |
描述 |
| 查询开放平台应用信息 |
/company/token/get |
GET |
查看文档 |
| 修改开放平台应用回调配置 |
/company/token/update/callback |
POST |
查看文档 |
沪公网安备 31011202012092号