接口描述
流程归档后,e签宝服务端会将签署后的文件哈希推送上链,对接方可通过流程flowId查询签署文件上链信息。
接口名称
/v1/querySignAntPushInfo
请求方式
POST
请求头
提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权(优先推荐)
请求头入参示例如下:
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
X-Tsign-Open-App-Id | string | 是 | 项目ID | |
Content-Type | string | 是 | application/json;charset=UTF-8 | |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击 | |
Accept | string | 是 | 建议统一填写 */* | |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 | |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。 | |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权,固定值,Signature |
方式二: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 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 | |
flowId | string | 是 | body | 签署流程ID。 签署流程需归档后,签署文件哈希才会推送上链 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码,0表示成功,非0表示失败 | |
message | string | 是 | 业务码信息 | |
data | object | 否 | 业务数据 |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |
antPushList | array | 否 | 签署流程上链的文件列表信息 | |
docHash | string | 是 | 签署文件的哈希值 注:用于核验上链信息。 | |
antTransactionId | string | 是 | 当前流程的签署文件上链事务的唯一标识 注:同一个签署流程存在多份签署文件时,antTransactionId不变 | |
antTxHash | string | 是 | 蚂蚁区块链统一证据编号 注:用于核验上链信息 | |
pushTime | string | 是 | 推送签署文件上链时间 注:同一个签署流程存在多份签署文件时,pushTime不变 |
请求示例
POST请求地址示例:
https://openapi.esign.cn/v1/querySignAntPushInfo
body体内JSON数据示例:
{ "flowId": "2645a6c581dd77fdd70b566399079e29" }
响应示例
{ "data": { "antPushList": [ { "docHash": "e3d635871f5f2d*****46568358a9fe40f0a90a58a039ee3", "antTransactionId": "fb0b621f-141b-4254-a411-28b8732adf8a", "antTxHash": "d8f5caf9910*****c4c7b2904bcb798ff3635eb3", "pushTime": 1592558315000 }, { "docHash": "e7fc48e2c87*****ec6a5940123897b355dea0be4990331b038", "antTransactionId": "fb0b621f-141b-4254-a411-28b8732adf8a", "antTxHash": "d56daedaeda70*****f27fafb91b1af3ea3bd3b84934ec4", "pushTime": 1592558315000 } ] }, "message": "成功", "code": 0 }
错误码
错误码 | 错误描述 | 解决方案 |
1480011 | 查询记录不存在 | |
1480012 | 查询记录不属于你 | |
1480013 | 该记录尚未推送 |