接口描述
可通过该接口申请”e签宝数据存证证明“电子版下载地址,该存证证明由e签宝出具,暂不收取费用。
注意:接口为异步出证,出证成功后,会通过回调地址返回存证证明与证据包下载地址。(回调地址请提供appId并联系e签宝服务人员进行配置)
接口名称
/v1/bridge/issueReport/apply
请求域名
开发环境 | 请求域名 | 公网IP | 端口 |
沙箱环境 | https://smlopenapi.esign.cn | 114.55.17.44 | 443 |
正式环境 | https://openapi.esign.cn | 118.31.181.75 | 443 |
请求方式
POST
请求头
方式二:OAuth2.0鉴权(不推荐)
当安全接入选择OAuth2.0鉴权方式,点击查看OAuthToken鉴权方式的详细说明。
方式一:请求签名鉴权方式(优先推荐)
请求签名鉴权方式所需请求头格式参数如下:
参数名称 | 参数 类型 | 参数必选 | 参数说明 (左右拖动查询完整描述) |
X-Tsign-Open-App-Id | string | 是 | 应用ID,通过e签宝开放平台获取。 沙箱模拟的应用ID获取方式详见此处。 正式生产的应用ID获取方式详见此处。 |
X-Tsign-Open-Auth-Mode | string | 是 | 接口鉴权方式,请填写固定值 Signature 。 |
X-Tsign-Open-Ca-Signature | string | 是 | 请求签名值,点击查看请求签名值计算说明。 |
X-Tsign-Open-Ca-Timestamp | string | 是 | 接口调用时的Unix时间戳,单位毫秒。 时间戳有效期为15分钟,但建议传入每次接口调用时的当前时间戳。 |
Accept | string | 是 | 响应数据类型,建议统一填写 */* |
Content-Type | string | 是 | 请求Body体数据的格式类型 建议填写 application/json; charset=UTF-8 GET 和 DELETE 请求且Body体无数据时,参数值可为""空字符串或不传此参数。 |
Content-MD5 | string | 否 | 请求Body体数据的 Content-MD5 值,点击查看 Content-MD5 计算方法 GET 和 DELETE 请求且Body体无数据时,此参数可为 ""(空字符串)或不传此参数。 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 | |
eid | string | 是 | body | 数据存证编号(只支持C开头的存证编号) | ||
type | string | 是 | body | 证据持有者证件类型,详情见下方枚举说明 ID_CARD:身份证 CODE_ORG:组织机构代码 CODE_USC:社会统一信用代码 CODE_REG:工商注册号 HK_CARD:香港居民来往内地通行证 MO_CARD:澳门居民来往内地通行证 TW_CARD:台湾居民来往大陆通行证 FOR_CARD:护照 | ||
number | string | 是 | body | 证据持有者证件号 |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码,0表示成功,非0表示失败 | |
message | string | 是 | 业务码信息 | |
data | object | 否 | 业务数据 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 |
reportId | string | 是 | 消息id |
请求示例
POST请求地址示例:
https://openapi.esign.cn/v1/bridge/issueReport/apply
body体内JSON数据示例:
{
"eid": "C1397448961480110001",
"number": "231182199605254329",
"type": "ID_CARD"
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"reportId": "1397463395472527001"
}
}
异步出证回调通知参数说明
- 目前通过HTTP协议,POST 方法进行通知调用,内容为 json 字符串;
- 对接方在接收到回调请求时,需返回HTTP 状态码 200;
- 为了保障异步通知的可靠性,建议业务方在回调请求处理中,尽可能减少业务操作,改用异步方式处理后续业务流程。
参数名称 | 必选 | 类型 | 参数说明 | |
action | 是 | string | 标记该通知的业务类型,该通知固定为:APPLY_ISSUE_REPORT | |
errCode | 是 | int | 0表示成功,其余失败 | |
msg | 是 | string | 错误信息 | |
reportId | 是 | string | 消息id | |
eid | 否 | string | 数据存证编码 | |
number | 否 | string | 证据持有者证件号 | |
type | 否 | string | 证据持有者证件类型,详情见下方枚举说明 ID_CARD:身份证 CODE_ORG:组织机构代码 CODE_USC:社会统一信用代码 CODE_REG:工商注册号 HK_CARD:香港居民来往内地通行证 MO_CARD:澳门居民来往内地通行证 TW_CARD:台湾居民来往大陆通行证 FOR_CARD:护照 | |
downloadUrl | 否 | string | 出证报告下载地址 | |
zipDownloadUrl | 否 | string | 压缩包下载地址(包含出证报告以及存储的文件原文) |
消息体示例
{
"action": "APPLY_ISSUE_REPORT",
"downloadUrl": "https://oss.esign.cn/1111564107/a3f8c9e6-1111-4f18-815d-baabfccd6199/C1905181224146567175.pdf?Expires=1743069176&OSSAccessKeyId=LTAI4G5MrNNRU1tH6qtY4Moi&Signature=h9Td68p%2BUBux%2BX6zC7FP9UUjEXc%3D",
"eid": "C190518111111567175",
"errCode": 0,
"msg": "成功",
"number": "91311111111111386T",
"reportId": "19051111119850630",
"type": "CODE_USC",
"zipDownloadUrl": "https://oss.esign.cn/1111564107/cd534d5a-1111-46bb-b7ef-ff34de6078e2/C1905181224146567175.zip?Expires=1743069176&OSSAccessKeyId=LTAI4G5MrNNRU1tH6qtY4Moi&Signature=sHjYrzJ4iJM7jrOyM2yjha67CLk%3D"
}