请求¶
访问星火·链网 星火印API需要使用https协议,并进行数字签名。
路径¶
API地址:
测试网络环境:https://test-stamp.bitfactory.cn/api
生产环境:https://stamp.bitfactory.cn/api
请求路径=API地址+接口名称,比如hash存证接口的名称是/evidence/hash,则请求路径为:
https://test-stamp.bitfactory.cn/api/evidence/hash
方法¶
所有的请求遵循RESTFUL方法
参数¶
通用请求头 headers¶
字段名 |
描述 |
---|---|
request_id |
请求号,由接入客户创建唯一字符串,长度不超过32位 |
access_key |
访问识别码,当您在星火印成功上传SM2公钥后会获得一个access_key |
nonce |
请求时间, 必须以 Unix Time 的格式发送, nonce与服务器时间不得超过正负900秒,否则请求将视为无效 |
signature |
使用你的SM2私钥进行签名后的字符串,具体签名的方法后面会进一步描述 |
例如:
"request_id": "2XiTgZ2oVrBgGqKQ1ruCKh"
"access_key": "2y7cg8kmoGDrDBXJLaizoD"
"nonce": "1464594744"
"signature": "cdVtQ52evi4YDIuygRRiGhosn5XZyDH63LhNMk10I0LFBAamfuEBb6A2vlynVYll2ASzC/yolU/pbEAZ0zxdtg=="
通用应答参数¶
字段名 |
描述 |
---|---|
code |
状态码 |
data |
返回数据 |
message |
错误描述 |
例如:
{
"data": {
"attestationId": "rBgGqKQ1ruCKhXiTgZ2oVr",
},
"message": "string",
"code": "string"
}
错误码¶
错误码 |
描述 |
---|---|
200 |
操作成功 |
500 |
系统内部错误 |
401 |
暂未登录或token已经过期 |
403 |
没有相关权限 |
1001 |
参数检验失败 |
1002 |
账户余额不足 |
1003 |
存证不存在 |
1004 |
存证失败 |
1005 |
存证处理中 |
1006 |
提取码错误 |
1007 |
存证文件已经过期 |
1008 |
请输入最大6个字符的标签 |
1009 |
请输入最大20个字符的文件名称 |
1010 |
请输入正确格式的文件hash值 |
1011 |
该文件已经做过存证 |
1012 |
请勿提交相同文件hash |
1013 |
存证失败,已存在相同文件hash的存证数据 |
1014 |
存证失败,请勿提交相同文件 |
1015 |
存证失败,文件有安全问题 |
2001 |
存证文件不存在 |
2002 |
上传文件失败 |
3001 |
用户不存在 |
3002 |
验证码错误 |
4001 |
业务流水不唯一 |
4002 |
权限校验失败 |