接口¶
初始化客户端¶
- ::
BaoquanClient client = new BaoquanClient();
- //设置api地址，比如保全网的测试环境地址
client.setHost(”https://api.baoquan.com”);
- // 设置access key
client.setAccessKey(“fsBswNzfECKZH9aWyh47fc”);
- // 设置rsa私钥文件的绝对路径
client.setPemPath(“path/to/rsa_private.pem”);
- // 设置版本
client.setVersion(“v3”);
内容保全 - /attestations/text¶
客户在保全网站上建好模板之后通过该接口传输模板渲染需要的数据。
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
String字符串，不超过255位，保全唯一码 |
必选 |
template_id |
String字符串，模板id |
必选 |
identities |
Object对象，身份事项 |
必选 |
factoids |
数组对象，陈述集 |
必选 |
transaction_id |
外部事物id |
非必选 |
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
文件保全 - /attestations/file¶
上传文件进行存证
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
String字符串，不超过255位，保全唯一码 |
必选 |
template_id |
String字符串，模板id |
必选 |
identities |
Object对象，身份事项 |
必选 |
factoids |
数组对象，陈述集 |
必选 |
transaction_id |
外部事物id |
非必选 |
attachment |
附件 |
必选 |
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
保全（sha256） - /attestations/hash¶
客户在保全网站上建好模板（文件HASH上传）之后通过该接口传输模板渲染需要的数据。
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
String字符串，不超过255位，保全唯一码 |
必选 |
template_id |
String字符串，模板（文件HASH模板）id |
必选 |
identities |
Object对象，身份事项 |
必选 |
factoids |
数组对象，陈述集 |
必选 |
sha256 |
文件的sha256值 |
必选 |
transaction_id |
外部事物id |
非必选 |
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
网页取证 - /attestations/url¶
根据网页地址固定证据
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
保全唯一码 必选 |
|
template_id |
模板id 必选 |
|
identities |
Object对象，身份事项 必选 |
|
factoids |
数组对象，陈述集 必选 |
|
mode |
网页url模式选择(默认传1) |
必选 |
url |
网页地址 必选 |
|
transaction_id |
外部事物id 非必选 |
|
evidenceName |
取证名称 非必选 |
|
evidenceLabel |
取证标签 非必选 |
|
callBackUrl |
回调地址 非必选 |
|
taskType |
任务类型 非必选 |
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
网页取证详情查询 - /attestations/url/info¶
过程取证详情查询
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
no |
保全号 |
必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
status |
状态 |
start_time |
开始取证时间 |
end_time |
结束取证时间 |
sm3 |
压缩包sm3 |
sha256 |
压缩包sha256 |
blockchain_hash |
链上hash值 |
imgUrl |
图片预览地址 |
状态值包含：
UNDERWAY |
取证中 |
TWO_STAGE |
待确认（2阶段取证待确认） |
SUCCESSED |
成功 |
FAILED |
失败 |
CANCEL |
取消 |
获取保全数据 - /attestations¶
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，保全号 |
必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
html |
保全书html |
file_hash |
文件国密sm3哈希 |
sha256 |
文件sha256哈希 |
status |
存证状态 |
blockchain_hash |
链上哈希 |
attestation_at |
存证时间 |
hhf_number |
杭互法编号 |
ghf_number |
广互法编号 |
category |
类型 |
evidenceCode |
提取码 |
fileTempUrl |
证据包临时地址 |
hash存证没有杭互和广互编号，因为互法需要源文件进行验证
status值包含：
COMPLETED |
保全完成 |
OSS_COMPLETED |
文件上传到OSS上完成 |
BLOCK_CHAIN_COMPLETED |
hash到区块链完成 |
category值包含：
ATTSETATION |
内容存证 |
ATTSETATIONFILE |
文件存证 |
ATTSETATIONMUSIC |
音乐取证 |
ATTSETATIONHASH |
文件存证 |
ATTSETATIONURL |
网页取证 |
PROCESSEVIDENCE |
过程取证 |
PROCESSEVIDENCE_PHONE |
移动端取证 |
ATTESTATION_ECOMMERCE |
网页电商取证 |
证书下载 - /attestations/pdf/download¶
证书下载
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
no |
String字符串，保全号 必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
imgBase |
保全证书 base64 已弃用 |
pdfUrl |
保全证书访问路径 （路径有有效期，可以直接下载或者再次需要的时候重新调用此接口） |
过程取证对接流程¶
1、获取过程取证token
2、打开取证页面进行操作 https://process.baoquan.com/evidences/{token}
3、取消过程取证（未进入机器前）、结束过程取证（进入机器后） （此步骤根据业务需求为可选步骤，页面上有提供取消和结束按钮）
4、查询取证详情信息
过程取证获取token - /process/token¶
过程取证获取token
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
String字符串，不超过255位，保全唯一码 |
必选 |
template_id |
String字符串，模板id |
必选 |
identities |
Object对象，身份事项 |
必选 |
factoids |
数组对象，陈述集 |
必选 |
transaction_id |
外部事物id |
非必选 |
evidenceType |
取证类型 |
必选 |
tag |
机器标签 |
非必选 |
evidenceType为取证类型字段当前选项为： PC（电脑端）、PHONE（手机端）
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
过程取证取消 - /process/cancel¶
取消过程取证
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，过程取证获取的token 值 |
必选 |
返回的data¶
取消成功 statusCode 为 000000 否则取消失败
过程取证结束 - /process/stop¶
结束过程取证
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，过程取证获取的token 值 |
必选 |
返回的data¶
结束成功 statusCode 为 000000 否则结束失败
过程取证查询 - /process/info¶
过程取证详情查询
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，过程取证获取的token 值 |
必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
status |
状态 |
start_time |
开始取证时间 |
end_time |
结束取证时间 |
video_duration |
视频时长 |
video_url |
视频路径 |
videoSha256 |
视频sha256 |
videoSm3 |
视频sm3 |
videoSize |
视频大小 |
zip_sm3 |
压缩包sm3 |
zip_sha256 |
压缩包sha256 |
blockchain_hash |
链上hash值 |
zipTempUrl |
压缩包临时访问路径 |
zipTempUrlExpiration |
压缩包临时访问路径过期时间 |
状态值包含：
NEW |
新创建取证 |
FELLIN |
排队中 |
RECORDING |
取证中 |
UPLOAD |
取证结束视频上传中 |
FINISHED |
取证成功 |
FAILED |
取证失败 |
CANCEL |
取消取证 |
音乐取证 - /attestations/music¶
音乐取证
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
unique_id |
保全唯一码 |
必选 |
template_id |
模板id |
必选 |
identities |
Object对象，身份事项 |
必选 |
factoids |
数组对象，陈述集 |
必选 |
transaction_id |
外部事物id |
非必选 |
evidenceName |
取证名称 |
非必选 |
evidenceLabel |
取证标签 |
非必选 |
platform |
平台 |
必选 |
url |
地址 |
必选 |
song |
歌曲 |
必选 |
singer |
歌手 |
必选 |
album |
专辑 |
非必选 |
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
音乐取证查询 - /music/info¶
音乐取证查询
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，过程取证获取的token 值 |
必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
status |
状态 |
start_time |
开始取证时间 |
end_time |
结束取证时间 |
video_duration |
视频时长 |
video_url |
视频路径 |
videoSha256 |
视频sha256 |
videoSm3 |
视频sm3 |
videoSize |
视频大小 |
zip_sm3 |
压缩包sm3 |
zip_sha256 |
压缩包sha256 |
blockchain_hash |
链上hash值 |
zipTempUrl |
压缩包临时访问路径 |
状态值包含：
UNDERWAY |
取证中 |
SUCCESSED |
取证成功 |
FAILED |
取证失败 |
电商取证 - /attestations/ecommerce¶
电商取证
payload¶
返回的data¶
调用保全接口成功后会返回保全号
字段名 |
描述 |
|---|---|
no |
String字符串，保全号 |
电商取证查询 - /ecommerce/info¶
音乐取证查询
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
String字符串，过程取证获取的token 值 |
必选 |
返回的data¶
字段名 |
描述 |
|---|---|
no |
保全号 |
status |
状态 |
start_time |
开始取证时间 |
end_time |
结束取证时间 |
video_duration |
视频时长 |
video_url |
视频路径 |
videoSha256 |
视频sha256 |
videoSm3 |
视频sm3 |
videoSize |
视频大小 |
zip_sm3 |
压缩包sm3 |
zip_sha256 |
压缩包sha256 |
blockchain_hash |
链上hash值 |
zipTempUrl |
压缩包临时访问路径 |
状态值包含：
UNDERWAY |
取证中 |
SUCCESSED |
取证成功 |
FAILED |
取证失败 |
hash存证上传文件 - evidence/hash¶
当hash存证需要出证时，需要先上传文件 再申请出证
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
ano |
保全号 |
必选 |
attachment |
附件文件 |
必选 |
返回的data¶
成功 statusCode 为 000000 否则上传失败
司法鉴定 - evidence/judicial¶
司法鉴定接口
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
anos |
要出证保全号（以逗号分割） |
必选 |
name |
出证名称 |
必选 |
evidenceDesc |
案件描述 |
必选 |
evidenceUseType |
案件类型 （0代表民事诉讼，1代表证据留存） |
必选 |
address |
地址 |
必选 |
userName |
用户手机号 |
必选 |
userPhone |
用户手机号 |
必选 |
返回的data¶
成功 statusCode 为 000000
公证出证 - evidence/notarization¶
公证出证接口
payload¶
参数名 |
描述 |
是否可选 |
|---|---|---|
anos |
要出证保全号（以逗号分割） |
必选 |
name |
出证名称 |
必选 |
address |
地址 |
必选 |
userName |
用户手机号 |
必选 |
userPhone |
用户手机号 |
必选 |
返回的data¶
成功 statusCode 为 000000