签盾开放平台-电子签约服务
  1. 文件相关
签盾开放平台-电子签约服务
  • 接入流程介绍
  • 应用创建流程
  • 前端接入文档
  • 开发前必读
    • 常用接口清单和关键流程
    • 公共请求格式
  • 帮助文档
    • 印章指定位置
    • 静默签使用说明
  • 实名认证
    • 个人认证
      • 个人认证项
        • 个人身份二要素核验
        • 个人运营商三要素核验
        • 个人人脸核验(H5适配)
        • 个人人脸核验查询
        • 发送短信验证码
        • 校验短信验证码
        • 个人银行卡四要素核验
      • 个人实名认证地址(页面)
    • 企业认证
      • 企业认证项
        • 企业四要素核验
        • 企业三要素核验
        • 发起打款认证(正向打款)
        • 验证打款金额(正向打款)
        • 查询打款进度(正向打款)
        • 企业经办人授权书认证-上传
        • 企业经办人授权书认证-查询
        • 查询打款银行信息
      • 企业实名认证地址(页面)
    • 查询认证信息
      GET
  • 用户管理
    • 个人用户
      • 修改个人用户
      • 创建已认证个人用户
      • 查询个人用户信息
    • 企业用户
      • 查询企业用户信息
      • 创建已认证企业用户
    • 创建未认证用户(暂不支持企业)
      POST
  • 文件相关
    • 上传文件
      POST
    • 基于模板生成文件
      POST
  • 合同相关
    • 通过文件发起合同
      POST
    • 查询签署方信息
      GET
    • 下载合同文件及附件
      GET
    • 合同查询
      GET
    • 获取合同签署链接(页面)
      POST
    • 无感签署(申请开放)
      POST
    • 获取拖章定位页面
      POST
  • 印章管理
    • 查询印章列表
      GET
    • 查询印章详情
      GET
    • 印章静默签授权地址(H5页面)
      POST
  • 接口回调
    • 回调接入文档
    • 获取回调信息
    • 回调成功确认
  • 开放接口
    • 短信验证码
    • 通知短信发送
    • 身份证OCR
    • 营业执照OCR
    • 银行卡OCR
  1. 文件相关

上传文件

POST
/open/file/upload
V1.0.0
二进制文件传输方式
***非创建合同接口,需配合【通过文件发起合同】完成合同创建。
1.
生成的文件可用于发起合同,文件可重复使用。
2.
合同文件支持pdf、doc、docx、jpg、jpeg、bmp、png格式,大小不超过10M。对应content-type见下表

请求头格式#

具体请求头参数,请查看公共请求格式
类型格式Content-Type
图片BMPimage/bmp
图片PNGimage/png
图片JPGimage/jpeg
图片JPEGimage/jpeg
wordDOCapplication/msword
wordDOCXapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
PDFPDFapplication/pdf
可能出现的错误码
错误码错误信息解决办法
500服务繁忙,请重试.联系客服
400参数错误.参数与接口文档进行核对
oc_30002文件上传失败重试,或联系客服
oc_30003您选择了一个空文件,请重新选择核对上传文件信息
oc_30004文件大小超出限制核对上传文件信息

请求参数

Query 参数
fileName
string 
必需
Header 参数
Content-Type
string 
必需
文件格式严格按照后缀选择,value值见说明
Body 参数application/octet-stream
未设置

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift

返回响应

🟢200成功
application/json
Body
code
string 
必需
msg
string 
必需
result
object 
必需
fileCode
string 
文件代码
必需
fileName
string 
文件名
必需
fileViewUrl
string 
预览链接
必需
success
boolean 
必需
示例
{
    "code": "200",
    "msg": "成功",
    "result": {
        "fileCode": "FC_20230414105522daGzUlQganifJBP",
        "fileName": "R-C.pdf",
        "fileUrl": "independent-signature-pri-dev:contract/pdf/2023/4/14/20230414105522tvuiKJfyYBOUMoxJFstv.pdf",
        "fileViewUrl": "https://independent-signature-pri-dev.devqd.work/contract/pdf/2023/4/14/20230414105522tvuiKJfyYBOUMoxJFstv.pdf?Expires=1681444524&OSSAccessKeyId=LTAI4FmuFfVmpcEJ8Dv3jZY5&Signature=T0VOfirhhbz%2BaEt6RBP39phvU%2Fc%3D"
    },
    "success": true
}
上一页
创建未认证用户(暂不支持企业)
下一页
基于模板生成文件
Built with