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

对接方服务端接口说明

1 功能说明#

该对接方接口用于接收JS-SDK 发送的请求,并将请求转发到契约锁开放平台接口地址中,在转发之前,需要为请求添加契约锁开放平台请求头。接口转发完成之后,需要将契约锁开放平台 返回的结果返回给JS-SDK 。
image.png

2 对接方接口实现说明#

对接方服务端接口需要可以解析如下请求格式的请求:

2.1 请求方法#

对接方接口对应的接口地址需要同时支持GET与POST两种请求方式。
GET 请求结构
请求名称参数类型参数说明
requestDatastring请求参数内容,json字符串形式
POST 请求结构
请求名称参数类型参数说明
filefile上传的文件
requestDatastring请求参数内容,json字符串形式

2.2 Content-Type#

对接方接口需要支持一下两种形式的请求,若请求为POST请求,则Content-Type为multipart/form-data;charset=UTF-8,若请求为GET请求,采用application/x-www-form-urlencoded;charset=UTF-8形式进行请求。

2.3 请求示例#

Http Get 请求示例:
GET /proxy HTTP/1.1
Host: [对接方服务器地址]
Content-Type: application/x-www-form-urlencoded;charset=UTF-8

requestData=%7B%22type%22%3A%22GET_SIGN_PIN%22%2C%22data%22%3A%7B%22contractId%22%3A%222579175115228254281%22%2C%22userId%22%3A%222465085257979585017%22%7D%7D
Http Post请求示例:
POST /proxy HTTP/1.1
Host: [对接方服务器地址]
cache-control: no-cache
Content-Type: multipart/form-data; charset=UTF-8; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

Content-Disposition: form-data; name="requestData"

{"type":"UPLOAD_IVS_MATERIAL","data":{"contractId":"2579175115228254281","userId":"2465085257979585017"}}
------WebKitFormBoundary7MA4YWxkTrZu0gW--,
Content-Disposition: form-data; name="requestData"

{"type":"UPLOAD_IVS_MATERIAL","data":{"contractId":"2579175115228254281","userId":"2465085257979585017"}}
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Content-Disposition: form-data; name="file"; filename="/C:/Users/Richard Cheung/Documents/契约锁/测试/参数模板.docx


------WebKitFormBoundary7MA4YWxkTrZu0gW--

3 对接方接口转发地址#

对接方接口需要在完成对JS-SDK 请求添加请求头后,将接口转发到契约锁开放平台接口地址,并将契约锁开放平台返回的数据内容返回给JS-SDK。
接口地址:
[host]/uniformapi
请求头说明:
请求头名说明
x-qys-open-timestamp签名时间戳值,Unix TimeStamp,单位:毫秒,示例:1568945484738
x-qys-open-signature签名校验位,生成方法:MD5(Access Token + Access Secret + Timestamp)
x-qys-open-accesstoken开放平台 App Token
转发请求示例:
POST /uniformapi HTTP/1.1
Host: https://openapi.qiyuesuo.cn
cache-control: no-cache
x-qys-open-timestamp: [对接方时间戳]
x-qys-open-signature: [对接方签名内容]
x-qys-open-accesstoken: [对接方密钥]
Content-Type: multipart/form-data; charset=UTF-8; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

Content-Disposition: form-data; name="requestData"

{"type":"UPLOAD_IVS_MATERIAL","data":{"contractId":"2579175115228254281","userId":"2465085257979585017"}}
------WebKitFormBoundary7MA4YWxkTrZu0gW--,
Content-Disposition: form-data; name="requestData"

{"type":"UPLOAD_IVS_MATERIAL","data":{"contractId":"2579175115228254281","userId":"2465085257979585017"}}
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Content-Disposition: form-data; name="file"; filename="/C:/Users/Richard Cheung/Documents/契约锁/测试/参数模板.docx


------WebKitFormBoundary7MA4YWxkTrZu0gW--

4 接口服务端代码示例#

Java Source Code:
https://github.com/qiyuesuo/jssdk-server/tree/master/jssdk-java-server
.Net Source Code:
https://github.com/qiyuesuo/jssdk-server/tree/master/jssdk-csharp-server
Python Source Code:
https://github.com/qiyuesuo/jssdk-server/tree/master/jssdk-python-server
PHP Source Code:
https://github.com/qiyuesuo/jssdk-server/tree/master/jssdk-php-server
上一页
集成方式说明
下一页
关于开发平台控制台的说明
Built with