1. 总体介绍
具体地,每个API的入参都是满足以下格式的json字符串:
- {
- "functionArg": 随调用SDK方法而变的入参json字符串 {
- },
- "transactionArg": 交易参数json字符串 {
- "invokerWeId": 用于索引私钥的WeIdentity DID,服务器端会凭此找到所托管的私钥
- }
- "functionName": 调用SDK方法名
- "v": API版本号
- }
参数说明:
functionArg是随不同的SDK调用方法而变的,具体的参数可以查看SDK接口文档;后文会为每个所提及的接口给出对应的链接
- transactionArg仅包括一个变量invokerWeId,由传入方决定使用在服务器端托管的具体哪个WeIdentity DID所对应的私钥
- 非必需,只有在那些需要使用不同身份发交易签名的方法(如CreateAuthorityIssuer等)才会需要;后文中详细说明
functionName是调用的SDK方法名,用于决定具体调用WeIdentity Java SDK的什么功能
v是调用的API方法版本
每个API的接口返回都是满足以下格式的json字符串:
- {
- "respBody": 随调用SDK方法而变的输出值json字符串 {
- }
- "ErrorCode": 错误码
- "ErrorMessage": 错误信息,成功时为"success"
- }
其中具体的输出值result亦是随不同的SDK调用方法而变的。
在后文中,我们将会逐一说明目前所提供的功能及其使用方式。