契约锁 API
新手指南
复制页面
契约锁 API
平台简介
平台简介
新手指南
接入流程
名称解释
接入示例
API协议
API协议
API文档
合同管理
合同管理-创建合同草稿
合同管理-用文件添加合同文档
合同管理-多文件添加合同文档
合同管理-用模板添加合同文档
合同管理-发起合同
合同管理-抄送合同
合同管理-修改签署方
合同管理-添加签署方
合同管理-浏览页面
合同管理-合同详情
合同管理-获取合同列表
合同管理-下载合同与附属文件
合同管理-下载合同文档
合同管理-强制结束合同
合同管理-上传强制结束附件
合同管理-合同文档添加水印
合同管理-合同延期
合同管理-获取合同操作记录
合同管理-获取 合同与附属文件下载链接
签署服务
签署服务-公章签署
签署服务-签署法人章
签署服务-审批
签署服务-合同催签
签署服务-签署页面
签署服务-预签署页面
签署服务-获取短链接
签署服务-撤回/作废合同
签署服务-自定义文件作废合同
签署服务-自定义模板文件作废合同
签署服务-签署作废合同
签署服务-签署个人签名
组织架构
组织架构-子公司列表
组织架构-发送子公司邀请
组织架构-移除子公司
组织架构-对接方信息
组织架构-公司详情
组织架构-获取企业信息变更链接
组织架构-员工列表
组织架构-添加员工
组织架构-更新员工
组织架构-员工详情
组织架构-管理员工角色
组织架构-移除员工
印章管理
印章管理-印章列表
印章管理-印章图片
印章管理-创建印章
印章管理-印章详情
印章管理-编辑印章
印章管理-创建图片印章
印章管理-管理印章状态
印章管理-删除印章
印章管理-公司印章
模板管理
模板管理-模板列表
模板管理-模板详情
模板管理-模版预览页面
模板管理-创建Word模板
模板管理-编辑模板
模板管理-管理模板状态
模板管理-下载模板
模板管理-删除模板
业务分类
业务分类-业务分类列表
业务分类-业务分类详情
个 人认证
个人认证-获取个人认证链接
个人认证-查询个人认证状态
企业认证
企业认证-获取企业认证链接PC
企业认证-获取企业认证链接H5
企业认证-获取企业认证链接-带营业执照PC
企业认证-获取企业认证链接- 带营业执照H5
企业认证-查询认证结果
外部客户
外部客户-新增外部客户
授权管理
授权管理-单点登录模块授权页面
授权管理-个人签名授权页面
授权管理-取消个人签名授权
授权管理-查询个人静默签授权记录
辅助工具
辅助工具-文件验签
信息校验
信息校验-个人身份校验
信息校验-企业身份校验
单点登录集成
集成流程说明
单点登录
单点登出
CAS验证接口规范
JS SDK文档
JS SDK简介
集成方式说明
对接方服务端接口说明
公告
关于开发平台控制台的说明
小程序插件
插件简介
插件集成说明
生成合同签署令牌
生成个人认证令牌
生成企业认证令牌
生成企业认证令牌(带营业执照)
插件更新记录
常见问题
认证问题
配置问题
接口问题
其他问题
数据模型
请求模型
CategoryRequest
UserRequest
SignatoryRequest
SealImageInfoRequest
ActionRequest
AttchmentRequest
UserAuthInfoRequest
CopySendReceiverRequest
OpenAuthModifyFieldRequest
TemplateParamRequest
CompanyRequest
StamperRequest
WatermarkRequest
StampersRequest
InvalidStamperBeanRequest
DocumentRequest
ContractCustomFieldRequest
返回模型
CompanyResponse
EmployeeResponse
SealResponse
UserResponse
TemplateReponse
TemplateParamReponse
CategoryResponse
CategoryDetailResponse
SignatoryResponse
ActionResponse
PersonAuthResponse
PersonRealNameResponse
CorpAuthResponse
CorpAuthInfoResponse
PersonalAuthAutoSignResponse
VerifierResponse
SignatureInfoResponse
VerifyResponse
EnterpriseBasicInfoResponse
ContractResponse
DocumentUrlResponse
ContractStreamBeanResponse
ContractBeanResponse
UserAuthInfoResponse
AttchmentResponse
StamperBeanResponse
SealStatisticsInfoResponse
DocumentResponse
ContractCustomFieldResponse
CopySendReceiverResponse
通用模型
新手指南
复制页面
接入流程
契约锁开放平台接入流程
#
申请接入
#
在契约锁开放平台网站点击【申请接入】按钮,之后按照提示的步骤进行操作,即可成功接入契约锁开放平台。
1. 注册账号
#
在申请接入前,首先需要你注册一个契约锁账号。
2. 填写申请表单
#
完成账号注册后,你需要根据实际的企业情况填写接入申请表单。
3. 沙箱环境测试联调
#
沙箱环境是为开发者提供的用于接口联调和功能开发的测试环境,若你已在测试环境完成接口联调,可跳过此步骤,进行正式上线。
开启沙箱服务,系统会根据申请表单提交的企业信息,自动为你接入测试环境(
https://open.qiyuesuo.cn),在测试环境中为你创建企业,并生成相应的接入令牌和印章信息,以帮助你快速地完成接口联调测试,更多配置可点击【电子签约平台】按钮,进入沙箱环境电子签约平台(https://cloud.qiyuesuo.cn)进行设置。
沙箱环境说明:
1)沙箱环境仅用于接口调试,在沙箱环境中创建的签约文件和签署动作不具备法律效应。
2)沙箱环境与生产环境数据隔离,沙箱环境完成接口调试后,需前往生产环境电子签约平台(
https://cloud.qiyuesuo.com)相应企业信息的维护。
3)请勿在沙箱环境进行压力测试,以免导致沙箱无法正常使用,若在使用中遇到问题,请联系在线客服。
4. 正式上线
#
完成接口功能调试后,即可正式上线。
首先需完成企业认证。
进行企业认证需准备的材料:
1)企业基本信息:单位名称、统一社会信用代码、法定代表人姓名、营业执照照片/扫描件
2)企业认证授权
提供两种认证授权方式
方法一:法人在线签署认证授权书
由该组织机构的法定代表人在线签署认证授权书即可完成企业认证。若您是法定代表人,那么直接在线签署即可;若您不是法定代表人,可将签署链接发送给企业法定代表人,通知其完成签署。
方法二:线下盖章授权+对公账户 打款
需要下载授权书模板并打印,之后线下加盖企业公章,完成后拍照/扫描上传由契约锁客户进行审核。
按照页面提示的打款要求,打款指定金额至契约锁账户。
以上两步均完成且由客户审核无误后即可完成企业认证。
完成认证后,点击【集成管理】按钮,前往契约锁云平台申请接入的令牌和密钥。
需要填写业务系统的名称、调用量以及简单的业务描述,提交后等待契约锁客服进行审核。
审核进度和结果可在云平台-集成管理中查看,若审核失败,可以重新提交审核或者删除当前的接入申请。
审核通过后,即可获取到接入令牌和密钥。为保证秘钥安全,在查看时需要进行手机号校验,通过后方可查看。
完成上述两个步骤后,代表你已成功接入。可在线上环境进行完整的接口功能验收。
接入配置说明
#
1. 基础信息配置
#
点击业务系统进入详情页,可进行该业务系统的相关配置