微签电子签名-SaaS互签接口文档v1.0.0.docVIP

FORWAVE复园 微签SaaSWebAPI接口说明

微签SaaS互签

WebAPI接口说明

forwave

上海复园电子科技有限公司

目录

TOC\o1-2\h\u24671.简介 1

279062.开发前准备 1

177142.1.接口请求说明 1

133562.2.请求签名Sign生成方法 2

177442.3.请求签名鉴权示例代码 3

270333.API文档 4

245283.1.接口调用流程说明: 4

218633.2.上传签章文件接口 4

101443.3.微签创建互签任务接口 5

94513.4.发起人签章接口或者公共签章接口 7

272283.5.下载文件 8

221453.6.删除文件 8

162134.API返回码 9

53704.1.常见HTTP状态码及处理方式 9

235164.2.公共错误码 9

18464.3.业务错误码-鉴权 10

160814.4.业务错误码-用户管理 10

322504.5.业务错误码-部门管理 11

55734.6.业务错误码-文件上传 11

309724.7.业务错误码-审批任务 12

41585.技术支持 12

TOC\o1-3\h\u

TOC\o1-3\h\u

PAGE14

简介

微签SaaSWebAPI互签接口通过调用微签SaaS云端接口实现。

此接口适用于企业方与个人的线上签署场景，如人事合同、确认单、旅游/教培/法律服务行业的合同协议等。

互签接口可以与Web、APP、小程序等业务系统或平台对接。业务系统平台准备好签署的文件后，只需调用互签接口，甲方双方即可在线签署同一份合同。

开发前准备

接口请求说明

字符编码

均使用UTF-8编码

时间戳说明

所有参数中使用的时间戳签都使用“Unix标准时间戳”。

“Unix标准时间戳”是指从1970年1月1日(UTC/GMT的午夜)开始所经过的毫秒数。

请求方法

如果无特殊说明，总是使用POST方法。

POST请求支持的Content-Type类型：

application/x-www-form-urlencoded

multipart/form-data(仅涉及文件流操作接口支持)

公共请求参数

参数名称

参数类型

数据类型

必选

参数说明

AppId

header

string

是

应用AppId

Timestamp

header

string

是

API调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击。

Sign

header

string

是

签名字符串，具体生成方法见下面1.2节说明。

AuthMode

header

string

是

鉴权方式，固定值为Signature

Data

body

string

是

业务参数，所有业务参数都必须放在这个参数中传递(除文件流，字节流等)。内部用json格式编码。

注:在具体的业务接口参数描述中，除非特殊说明，都是Data内的参数。

公共响应参数

参数名称

参数类型

数据类型

必选

参数说明

code

body

string

是

返回码，10000表示成功，其余表示失败。

msg

body

string

是

返回码描述信息。

data

body

object

否

返回的业务数据，内容为json格式。

请求签名Sign生成方法

为保证API调用过程的安全可靠，微签平台webapi接口在调用前首先进行鉴权，采用对请求数据进行签名的方式实现安全接入，防止请求过程数据被篡改或盗用。

请求签名鉴权前准备

第三方请先向复园商务人员获取APPID和APPSECRET。

参数筛选并排序

对公共请求参数（不包括Sign字段），不包括字节流型参数(如文件流、字节流)，并按照参数键值ASCII码递增排序(字母升序排序)。

参数拼接

将上述筛选和排序后的参数与其对应值，组合成“参数名=参数值(Key=Value)”的格式，并且把这些参数用字符连接起来，此时生成的字符串为待签名字符串。

计算签名

使用APPSECRET对第三步拼接后的字符串采用HMAC-SHA256算法进行签名运算，最后经过Base64编码从而得到签名字符串。

请求签名鉴权示例代码

//AppId,AppSecret请联系微签商务人员获取

//AppSecret属于机密信息，请勿泄露，妥善保管

StringappId=100000;

StringappSecret=ead6c5bceae14ea