CptService - 2. registerCpt - 《WeIdentity 文档》

2. registerCpt

2. registerCpt

基本信息

接口名称: com.webank.weid.rpc.CptService.registerCpt
接口定义: ResponseData<CptBaseInfo> registerCpt(CptMapArgs args, Integer cptId)
接口描述: 传入WeIdentity DID，JsonSchema(Map类型), cptId 和其对应的私钥，链上注册指定cptId的CPT，返回CPT编号和版本。

接口入参:

名称	类型	非空	说明	备注
args	CptMapArgs	Y	Map类型参数注册CPT
cptId	Integer	Y	指定的cptId

com.webank.weid.protocol.request.CptMapArgs

名称	类型	非空	说明	备注
weIdAuthentication	WeIdAuthentication	Y	认证信息，包含WeIdentity DID和私钥	用于WeIdentity DID的身份认证
cptJsonSchema	Map<String, Object>	Y	Map类型的JsonSchema信息	基本使用见调用示例

com.webank.weid.protocol.base.WeIdAuthentication

名称	类型	非空	说明	备注
weId	String	Y	CPT发布者的WeIdentity DID	WeIdentity DID的格式传入
weIdPublicKeyId	String	N	公钥Id
weIdPrivateKey	WeIdPrivateKey	Y		交易私钥，见下

com.webank.weid.protocol.base.WeIdPrivateKey

名称	类型	非空	说明	备注
privateKey	String	Y	私钥值	使用十进制数字表示

接口返回: com.webank.weid.protocol.response.ResponseData<CptBaseInfo>;

名称	类型	说明	备注
errorCode	Integer	返回结果码	此接口返回的code
errorMessage	String	返回结果描述
result	CptBaseInfo		CPT基础数据，见下
transactionInfo	TransactionInfo	交易信息

com.webank.weid.protocol.response.TransactionInfo

名称	类型	说明
blockNumber	BigInteger	交易块高
transactionHash	String	交易hash
transactionIndex	BigInteger	交易索引

com.webank.weid.protocol.base.CptBaseInfo

名称	类型	说明	备注
cptId	Integer	cpId编号
cptVersion	Integer	版本号

此方法返回code

enum	code	desc
SUCCESS	0	成功
WEID_INVALID	100101	WeIdentity DID无效
WEID_PRIVATEKEY_INVALID	100103	私钥无效
WEID_PRIVATEKEY_DOES_NOT_MATCH	100106	私钥与WeIdentity DID不匹配
WEID_AUTHORITY_INVALID	100109	授权信息无效
CPT_JSON_SCHEMA_INVALID	100301	schema无效
CPT_EVENT_LOG_NULL	100304	交易日志异常
TRANSACTION_TIMEOUT	160001	超时
TRANSACTION_EXECUTE_ERROR	160002	交易错误
UNKNOW_ERROR	160003	未知异常
ILLEGAL_INPUT	160004	参数为空
CPT_NOT_EXISTS	500301	CPT不存在
CPT_ID_AUTHORITY_ISSUER_EXCEED_MAX	500302	为权威机构生成的cptId超过上限
CPT_PUBLISHER_NOT_EXIST	500303	CPT发布者的WeIdentity DID不存在
CPT_ALREADY_EXIST	500304	CPT已经存在
CPT_NO_PERMISSION	500305	CPT无权限

调用示例

CptService cptService = new CptServiceImpl();
 
HashMap<String, Object> cptJsonSchema = new HashMap<String, Object>(3);
cptJsonSchema.put(JsonSchemaConstant.TITLE_KEY, "cpt template");
cptJsonSchema.put(JsonSchemaConstant.DESCRIPTION_KEY, "this is a cpt template");
 
HashMap<String, Object> propertitesMap1 = new HashMap<String, Object>(2);
propertitesMap1.put(JsonSchemaConstant.TYPE_KEY, JsonSchemaConstant.DATA_TYPE_STRING);
propertitesMap1.put(JsonSchemaConstant.DESCRIPTION_KEY, "this is name");
 
String[] genderEnum = { "F", "M" };
HashMap<String, Object> propertitesMap2 = new HashMap<String, Object>(2);
propertitesMap2.put(JsonSchemaConstant.TYPE_KEY, JsonSchemaConstant.DATA_TYPE_STRING);
propertitesMap2.put(JsonSchemaConstant.DATA_TYPE_ENUM, genderEnum);
 
HashMap<String, Object> propertitesMap3 = new HashMap<String, Object>(2);
propertitesMap3.put(JsonSchemaConstant.TYPE_KEY, JsonSchemaConstant.DATA_TYPE_NUMBER);
propertitesMap3.put(JsonSchemaConstant.DESCRIPTION_KEY, "this is age");
 
HashMap<String, Object> propertitesMap4 = new HashMap<String, Object>(2);
propertitesMap4.put(JsonSchemaConstant.TYPE_KEY, JsonSchemaConstant.DATA_TYPE_STRING);
propertitesMap4.put(JsonSchemaConstant.DESCRIPTION_KEY, "this is id");
 
HashMap<String, Object> cptJsonSchemaKeys = new HashMap<String, Object>(3);
cptJsonSchemaKeys.put("name", propertitesMap1);
cptJsonSchemaKeys.put("gender", propertitesMap2);
cptJsonSchemaKeys.put("age", propertitesMap3);
cptJsonSchemaKeys.put("id", propertitesMap4);
cptJsonSchema.put(JsonSchemaConstant.PROPERTIES_KEY, cptJsonSchemaKeys);
 
String[] genderRequired = { "id", "name", "gender" };
cptJsonSchema.put(JsonSchemaConstant.REQUIRED_KEY, genderRequired);
 
WeIdPrivateKey weIdPrivateKey = new WeIdPrivateKey();
weIdPrivateKey.setPrivateKey("60866441986950167911324536025850958917764441489874006048340539971987791929772");
 
WeIdAuthentication weIdAuthentication = new WeIdAuthentication();
weIdAuthentication.setWeId("did:weid:101:0x39e5e6f663ef77409144014ceb063713b65600e7");
weIdAuthentication.setWeIdPrivateKey(weIdPrivateKey);
 
CptMapArgs cptMapArgs = new CptMapArgs();
cptMapArgs.setCptJsonSchema(cptJsonSchema);
cptMapArgs.setWeIdAuthentication(weIdAuthentication);
 
ResponseData<CptBaseInfo> response = cptService.registerCpt(cptMapArgs, 101);

返回数据如下：
result:(com.webank.weid.protocol.base.CptBaseInfo)
   cptId: 101
   cptVersion: 1
errorCode: 0
errorMessage: success
transactionInfo:(com.webank.weid.protocol.response.TransactionInfo)
       blockNumber: 29950
       transactionHash: 0xe3f48648beee61d17de609d32af36ac0bf4d68a9352890b04d53841c4949bd13
       transactionIndex: 0