1.接口请求域名
所有接口的请求调用要使用HTTPS协议、JSON数据格式、UTF8编码。
域名信息如下:
环境 | 域名 | 公网IP | 端口 |
正式生产环境 | 118.31.181.75 | 443 | |
沙箱模拟环境 | 114.55.17.44 | 443 |
环境说明
1. 若开发者需要配置防火墙后才可以访问互联网资源,请点击链接查看更多e签宝域名信息。
2. 调用 smlopenapi.esign.cn 下的接口全都属于沙箱模拟环境,正式生产调用请使用 openapi.esign.cn。
3. 沙箱模拟环境下签署的合同属于测试文件,不具备任何法律效力。正式上线请务必切换到正式生产环境使用。
4. 沙箱模拟环境与正式生产环境数据不互通,正式使用时请注意重新创建相关账号及数据。
2.公共请求头格式
方式一:请求签名鉴权(优先推荐)
下方请求头格式为请求签名鉴权方式,点击查看《请求签名鉴权》更多说明。
参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) |
X-Tsign-Open-Auth-Mode | string | 是 | 接口鉴权方式,请填写固定值Signature |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Open-Ca-Signature | string | 是 | 请求签名值,查看请求签名值计算说明。 |
X-Tsign-Open-Ca-Timestamp | string | 是 | 接口调用时的Unix时间戳,单位毫秒。 防重放攻击,时间戳有效期为15分钟。 |
Content-MD5 | string | 否 | 当请求Body体为非Form格式时,需要对Body体计算ContentMD5并传给网关进行校验。 application/json格式的Body体时此项必选。 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
Accept | string | 是 | 建议统一填写 */* |
方式二:OAuth2.0鉴权(不推荐使用)
下方请求头格式为OAuth2.0鉴权方式,请点击查看《OAuth2.0鉴权》详细说明。
参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) |
X-Tsign-Open-App-Id | string | 是 | 应用ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
3.公共响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) | |
code | int32 | 是 | 业务码,0表示成功 | |
message | string | 否 | 业务信息 | |
data | object | 否 | 业务数据 | |
…… | …… | …… | …… | |
…… | …… | …… | …… |
注:
- e签宝会对 message 进行文案调整,请不要根据 message 进行业务逻辑判断。
- code 非0时均代表业务失败或异常,开发者可使用 code 进行业务逻辑判断。
- 接口调用出现报错时,开发者可通过错误码查询工具查找错误排查方法。