通用说明
更新时间:2023-05-05
调用说明
- XUPEREVID司法存证API调用遵循HTTP协议,
- XUPEREVID司法存证API调用域名为https://xuper.baidu.com
- AK/SK 请在智能云平台的控制台申请
- SK是该APP准入认证密钥,妥善保管,不能泄露
- 所有request/response body内容均采用UTF-8编码
实名认证
使用XUPEREVID司法存证API的用户需要实名认证,没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。没有通过实名认证的用户将无法使用接口
API鉴权机制
所有API的安全认证一律采用AccessKey与请求签名机制。 Access Key由AccessKey ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。认证字符串的格式为
bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。
- signature是256位签名的十六进制表示,由64个小写字母组成。 当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证。
SDK
目前只提供PHP的SDK 其他常用语言的sdk 开发正在紧急开发中
公共请求头
所有请求必须在Header中携带以下参数,用于准入鉴权认证
参数 | 类型 | 描述 |
---|---|---|
Authorization | string | 通过鉴权认证算法生成的鉴权字符串 |
Host | string | 请求HOST,用于鉴权认证,不包含port |
Content-Type | string | application/x-www-form-urlencoded;charset=utf-8 |
HTTP协议的标准头域不在这里列出。公共头域将在每个API中出现,是必需的头域。
通用返回码
错误码 | 含义 | 特别说明 |
---|---|---|
1020004 | URL不存在 | |
1020005 | 产品线未授权 | |
1020007 | 签名错误 | |
1020008 | 参数不合法 | |
1020009 | 内部错误 | 多用于接口内部逻辑异常,不用特别关注 |
1020010 | 数据库操作失败 | |
10280001 | 错误的APPID | |
10280002 | 签名错误 | |
10280003 | 创建地址失败 | |
10280004 | 重复请求 | |
10280005 | 没有余量 | |
10280006 | 用户不存在 | |
10280007 | 存证失败 | |
10280008 | 无效的地址 | |
10280009 | hash重复 | |
10280010 | 无效用户 | 用户不存在或者没有通过司法连白名单 |
10280011 | 用户存证类型错误 | 不是合法的user_type用户存证类型 |
10280012 | 存证类型错误 | 不是合法的evidence_type类型 |
10280013 | 存证address和支付address不相符 | 预付费用户给他人存证 |
10280014 | 传入requestid错误 | 查询requestid 不存在或者不属于该渠道和用户 |
10280015 | 传入eid错误 | 查询 不存在或者不属于该渠道和用户 |
10280016 | 传入eid已经存在 | 提交存证的eid记录已存在 |
10280017 | 传入x-bce-date已过期 | |
10280018 | 传入old_txid不存在 | |
10280019 | xchain内部链接错误 | |
10280020 | 地址没通过企业认证 | |
10280021 | address 不属于当前ak | |
10280022 | 证书存储错误 | |
10280023 | 无效的出证法院短名乘 | |
10280024 | 法院已出证 | |
10280025 | 选择的法院无法出证 | |
10280026 | 无效的evidence_type |