契约锁 API
  1. 合同管理
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
        POST
      • 合同管理-用文件添加合同文档
        POST
      • 合同管理-多文件添加合同文档
        POST
      • 合同管理-用模板添加合同文档
        POST
      • 合同管理-发起合同
        POST
      • 合同管理-抄送合同
        POST
      • 合同管理-修改签署方
        POST
      • 合同管理-添加签署方
        POST
      • 合同管理-浏览页面
        GET
      • 合同管理-合同详情
        GET
      • 合同管理-获取合同列表
        GET
      • 合同管理-下载合同与附属文件
        GET
      • 合同管理-下载合同文档
        GET
      • 合同管理-强制结束合同
        POST
      • 合同管理-上传强制结束附件
        POST
      • 合同管理-合同文档添加水印
        POST
      • 合同管理-合同延期
        POST
      • 合同管理-获取合同操作记录
        GET
      • 合同管理-获取合同与附属文件下载链接
        GET
    • 签署服务
      • 签署服务-公章签署
      • 签署服务-签署法人章
      • 签署服务-审批
      • 签署服务-合同催签
      • 签署服务-签署页面
      • 签署服务-预签署页面
      • 签署服务-获取短链接
      • 签署服务-撤回/作废合同
      • 签署服务-自定义文件作废合同
      • 签署服务-自定义模板文件作废合同
      • 签署服务-签署作废合同
      • 签署服务-签署个人签名
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
      • 模板管理-模板详情
      • 模板管理-模版预览页面
      • 模板管理-创建Word模板
      • 模板管理-编辑模板
      • 模板管理-管理模板状态
      • 模板管理-下载模板
      • 模板管理-删除模板
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 合同管理

合同管理-创建合同草稿

POST
/v2/contract/draft
根据业务分类的预设配置或者接口的传参,创建相应的合同草稿,业务分类在契约锁云平台中配置。若合同文件已提前在云平台业务分类中维护,可通过send参数设置创建并直接发起合同。创建合同草稿后,支持传入合同id或bizId,进行草稿合同信息的覆盖修改。

请求参数

Header 参数

Body 参数application/json

示例
{
  "sn": "0219",
  "subject": "测试回调SaaS空20",
  "description": "合同描述",
  "expireTime": "2022-12-27 23:59:58",
  "endTime":"2022-12-27 00:00:00",
  "ordinal": false,
  "send": true,
  "tenantName": "上海契约锁电子合同签名有限公司",
  "creator": {
    "contact": "15021504325",
    "contactType": "MOBILE"
  },
 
  "signatories": [{
      "tenantType": "COMPANY",
      "tenantName": "上海契约锁电子合同签名有限公司",
      "receiver": {
        "contact": "15021504325",
        "contactType": "MOBILE"
      },
      "serialNo": 1,
      "actions": [{
        "type": "COMPANY",
        "name": "单位签章" 
      }]
  },
    {
      "tenantType": "PERSONAL",
       "tenantName": "朱明月",
           "receiver": {
                "contact": "test001",
                "contactType": "BIZID"
            },
      "delaySet":"true",
      "serialNo": "4"
    }
  ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.qiyuesuo.com/v2/contract/draft' \
--header 'x-qys-open-accesstoken: {{x-qys-open-accesstoken}}' \
--header 'x-qys-open-timestamp: {{x-qys-open-timestamp}}' \
--header 'x-qys-open-nonce: {{x-qys-open-nonce}}' \
--header 'x-qys-open-signature: {{x-qys-open-signature}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "sn": "0219",
  "subject": "测试回调SaaS空20",
  "description": "合同描述",
  "expireTime": "2022-12-27 23:59:58",
  "endTime":"2022-12-27 00:00:00",
  "ordinal": false,
  "send": true,
  "tenantName": "上海契约锁电子合同签名有限公司",
  "creator": {
    "contact": "15021504325",
    "contactType": "MOBILE"
  },
 
  "signatories": [{
      "tenantType": "COMPANY",
      "tenantName": "上海契约锁电子合同签名有限公司",
      "receiver": {
        "contact": "15021504325",
        "contactType": "MOBILE"
      },
      "serialNo": 1,
      "actions": [{
        "type": "COMPANY",
        "name": "单位签章" 
      }]
  },
    {
      "tenantType": "PERSONAL",
       "tenantName": "朱明月",
           "receiver": {
                "contact": "test001",
                "contactType": "BIZID"
            },
      "delaySet":"true",
      "serialNo": "4"
    }
  ]
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "result": {
        "id": "3053227767890968697",
        "subject": "接口发起",
        "description": "合同描述",
        "sn": "接口发起",
        "tenantName": "思晨教育",
        "ordinal": true,
        "category": {
            "id": "3053202902198805409",
            "name": "自动化测试-勿动zxs"
        },
        "creator": {
            "name": "韩军超",
            "contact": "18663049557",
            "contactType": "MOBILE"
        },
        "status": "DRAFT",
        "expireTime": "2023-02-17 15:17:06",
        "signatories": [
            {
                "id": "3053227768113266811",
                "tenantType": "COMPANY",
                "status": "DRAFT",
                "tenantName": "思晨教育",
                "receiver": {
                    "name": "韩军超",
                    "contact": "18663049557",
                    "contactType": "MOBILE"
                },
                "serialNo": 0,
                "actions": [
                    {
                        "id": "3053227768201347196",
                        "type": "AUDIT",
                        "status": "INIT",
                        "name": "审批动作",
                        "serialNo": 0,
                        "autoSign": false,
                        "operators": [
                            {
                                "contact": "18663049557",
                                "contactType": "MOBILE"
                            }
                        ]
                    },
                    {
                        "id": "3053227768226513022",
                        "type": "LP",
                        "status": "INIT",
                        "name": "法人签署动作",
                        "serialNo": 1,
                        "autoSign": false
                    },
                    {
                        "id": "3053227768289427583",
                        "type": "COMPANY",
                        "status": "INIT",
                        "name": "公章签署动作",
                        "serialNo": 2,
                        "autoSign": false,
                        "operators": [
                            {
                                "contact": "18663049557",
                                "contactType": "MOBILE"
                            }
                        ]
                    }
                ],
                "delaySet": false,
                "sponsor": true
            },
            {
                "id": "3053227768331370625",
                "tenantType": "PERSONAL",
                "status": "DRAFT",
                "tenantName": "韩军超",
                "receiver": {
                    "contact": "18663049557",
                    "contactType": "MOBILE"
                },
                "serialNo": 1,
                "delaySet": false,
                "sponsor": false
            }
        ]
    },
    "code": 0,
    "message": "SUCCESS"
}
修改于 2023-01-19 03:00:25
上一页
API协议
下一页
合同管理-用文件添加合同文档
Built with