卡片模板的创建是接入流程的第一步,这一步可以通过http/https请求的方式向华为钱包云服务提供卡券样式的关键信息,如卡面主标题、副标题、logo、背景图片等,用于华为钱包会员卡页面的展示。
开发者可创建多个共享相同机构名和服务号但模板ID不同的模板。在申请会员卡时,每张卡必须绑定唯一的模板ID,即一个模板可被多张会员卡复用,而一张会员卡仅能关联一个模板ID。
承载协议:HTTPS POST
接口方向:开发者业务管理服务->钱包云服务
接口URL:https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass/v2/{cardType}/model
数据格式:
请求消息:Content-Type: application/json;charset=UTF-8
响应消息:Content-Type: application/json;charset=UTF-8
Request Header
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 请求的数据类型,取值为:application/json;charset=UTF-8。 |
| Authorization | 是 | String | 认证信息,将获取AccessToken获取到的“access_token”的值拼接在字符串“Bearer”之后,以空格符相隔,组成“Authorization”参数的值。 |
| Accept | 是 | String | 响应的数据格式,取值为:application/json;charset=UTF-8。 |
Request Body
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| passTypeIdentifier | 是 | String | 创建Wallet Kit服务时注册的服务号,格式为:hwpass.xxx.xxx.xxx(xxx可为公司/产品名称,总长度不超过32个英文小写字符,请严格按照此规则定义)。 |
| passStyleIdentifier | 是 | String | 模板ID,长度不超过64个字符,只能是字母、数字、“.”、“-”和“_”。 |
| organizationName | 是 | String | 商户名称,最长64个字节,无具体格式要求,中英文均可。 |
| passVersion | 是 | String | Pass版本号,固定“10.0”。 |
| fields | 是 | fields | 卡券展示信息,包括appendFields和commonFields两部分。 |
| appendFields参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| isCreateWhiteCard | 是 | String | 是否为NFC卡的标记。 true:NFC卡。 false:非NFC卡。 |
| commonFields参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| logo | 是 | String | 卡面logo,128*128px,大小<=20kb,直角图片,无需切圆角。 |
| backgroundImage | 是 | String | 卡面背景 1312*820px,直角图片,无需切圆角。 |
| picUrl | 是 | String | 带logo的卡面背景 1312*820px,直角图片,无需切圆角。 |
| merchantName | 是 | String | 卡面主标题,小于256字节。 |
| name | 是 | String | 卡面副标题,小于256字节。 |
POST /hmspass/v2/key_member/model HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer bKyECwrVGw********************e
Accept: application/json;charset=UTF-8
{
"passVersion": "10.0",
"passTypeIdentifier": "hwpass.xxx.xxx.xxx",
"passStyleIdentifier": "keyMemberModelTest",
"organizationName": "xxx",
"fields": {
"appendFields": [
{
"label": "NFCCardFlag",
"value": "false",
"key": "isCreateWhiteCard"
}
],
"commonFields": [
{
"label": "卡面主标题",
"value": "会员卡",
"key": "merchantName"
},
{
"label": "卡面副标题",
"value": "XXX会员卡",
"key": "name"
},
{
"label": "",
"value": "https://xxx/xxx.png",
"key": "logo"
},
{
"label": "",
"value": "https://xxx/xxx.webp",
"key": "backgroundImage"
},
{
"label": "",
"value": "https://xxx/xxx.png",
"key": "picUrl"
}
]
}
} public HwWalletObject invokeHwCreateKeyMemberClass(){
HwWalletObject request=new HwWalletObject();
request.setPassVersion("10.0");
request.setPassTypeIdentifier("hwpass.keymember.test");
request.setPassStyleIdentifier("keyMemberModelTest");
request.setOrganizationName("XXXX");
Fields fields=new Fields();
fields.setCountryCode("CN");
List<ValueObject> commonFields=new ArrayList<>();
ValueObject logo=new ValueObject();
logo.setKey("logo");
logo.setValue("https://www.huawei.com/XXX.png");
commonFields.add(logo);
fields.setCommonFields(commonFields);
request.setFields(fields);
HttpHeaders header=constructHttpHeaders();
String baseUrl="https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass";
String walletServerUrl=baseUrl+"/v2/key_member/model";
HttpEntity<JSONObject> entity=new HttpEntity<>(JSONObject.parseObject(JSONObject.toJSONString(request)),header);
ResponseEntity<JSONObject> exchange = REST_TEMPLATE.exchange(walletServerUrl,HttpMethod.POST,entity,JSONObject.class);
return JSONObject.parseObject(exchange.getBody().toJSONString(),HwWalletObject.class);
} 开发者向开发者服务器申请开通会员卡,开发者服务器将会员卡卡片信息添加至钱包云服务中。其中:开发者App->开发者服务之间的交互由开发者自行实现,本章主要侧重于开发者服务器->钱包云服务申请会员卡的过程,主要包括:申请卡片和生成JWE数据。
承载协议:HTTPS POST
接口方向:开发者业务管理服务->钱包云服务
接口URL:https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass/v2/{cardType}/instance
数据格式:
请求消息:Content-Type: application/json;charset=UTF-8
响应消息:Content-Type: application/json;charset=UTF-8
Request Header
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 请求的数据类型,取值为:application/json;charset=UTF-8。 |
| Authorization | 是 | String | 认证信息,将获取AccessToken获取到的“access_token”的值拼接在字符串“Bearer”之后,以空格符相隔,组成“Authorization”参数的值。 |
| Accept | 是 | String | 响应的数据格式,取值为:application/json;charset=UTF-8。 |
Request Body
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| passTypeIdentifier | 是 | String | 创建Wallet Kit服务时注册的服务号,格式为:hwpass.xxx.xxx.xxx(xxx可为公司/产品名称,总长度不超过32个英文小写字符,请严格按照此规则定义)。 |
| passStyleIdentifier | 是 | String | 模板ID,长度不超过64个字符,只能是字母、数字、“.”、“-”和“_”。 |
| organizationName | 是 | String | 预置模板中创建的商户名称,最长64个字节。 |
| organizationPassId | 是 | String | 会员卡卡片在开发者服务器中的卡号。在同一个appId下唯一。长度16个字节,为保证唯一性,请勿手动输入,建议使用代码随机生成,只能是字母、数字,当前和serialNumber保持一致。 |
| serialNumber | 是 | String | 会员卡卡片在华为钱包服务器中的卡号,即instanceId。在同一个appId下唯一。长度16个字节,为保证唯一性,请勿手动输入,建议使用代码随机生成,只能是字母、数字,当前和organizationPassId保持一致。 |
| fields | 是 | fields | 卡券展示信息,包括commonFields、barCode、status、localized部分。 |
| status参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| state | 是 | String | 状态值。取值如下: - active:生效 - inactive:未激活 - completed:已使用 - expired:已过期 |
| effectTime | 否 | String | 生效时间,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 |
| expireTime | 否 | String | 失效时间,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。如果超过此时间,卡券自动按照expired状态处理。 |
| localized参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 否 | String | 国际化键名。无固定值,根据实际需要国际化的字段传入对应键名即可。 |
| value | 否 | String | 国际化文本,对应语言的显示内容。 |
| language | 否 | String | 语言代码,如zh-CN、en-US。 |
| barCode参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| text | 否 | String | 二维码下方显示的描述或数字。 |
| type | 否 | String | 二维码类型,固定值:'qrCode'。 |
| value | 否 | String | 二维码码值。 |
| encoding | 否 | String | 编码格式,固定值:'UTF-8'。 |
| commonFields参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ownerPassTypeIdentifier | 是 | String | 服务号,格式为:hwpass.xxx.xxx.xxx。 |
| readerMatchValue | 是 | String | 会员卡标识,建议不超过20个字节,第一字节表示开发者标识,第二字节表示品牌/系列标识,后续的字节用于保证开发者内唯一性。字符只能包含0-9和A-F。 |
| deviceType | 是 | String | 当前会员卡开通的设备类型,Phone:手机,Wear:穿戴。 |
| personalizedData | 否 | Object | 开发者个性化数据。 |
| logo | 否 | String | 卡面logo,128*128px,大小<=20kb,直角图片,无需切圆角。 如果此处携带该参数,则会覆盖对应模板中的相应字段数据。 |
| backgroundImage | 否 | String | 卡面背景,1312*820px,直角图片,无需切圆角。 如果此处携带该参数,则会覆盖对应模板中的相应字段数据。 |
| picUrl | 否 | String | 带logo的卡面背景,1312*820px,直角图片,无需切圆角。 如果此处携带该参数,则会覆盖对应模板中的相应字段数据。 |
| merchantName | 否 | String | 卡面主标题,小于256字节。 如果此处携带该参数,则会覆盖对应模板中的相应字段数据。 |
| name | 否 | String | 卡面副标题,小于256字节。 如果此处携带该参数,则会覆盖对应模板中的相应字段数据。 |
POST /hmspass/v2/key_member/instance HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer bKyECwrVGw********************e
Accept: application/json;charset=UTF-8
{
"organizationPassId": "5623489234",
"passTypeIdentifier": "hwpass.type.member.test",
"passStyleIdentifier": "class_member_Test",
"serialNumber": "70001",
"fields": {
"status": {
"state": "active",
"effectTime": "2019-11-13T00:00:00.111Z",
"expireTime": "2020-11-20T00:00:00.111Z"
},
"barCode": {
"text": "562348969211212",
"type": "qrCode",
"value": "562348969211212",
"encoding": "UTF-8"
},
"commonFields": [
{
"key": "merchantName",
"value": "XX商户",
"label": "merchantName"
},
{
"key": "name",
"value": "XX会员卡",
"label": "name"
},
{
"key": "logo",
"value": "https://xxx/xxx.png",
"label": "logo"
},
{
"key": "backgroundImage",
"value": "https://xxx/xxx.webp",
"label": "backgroundImage"
},
{
"key": "picUrl",
"value": "https://xxx/xxx.png",
"label": "picUrl"
}
],
"localized": [
{
"key": "merchantNameLabel",
"value": "商户名称",
"language": "zh-CN"
},
{
"key": "merchantNameLabel",
"value": "Merchant",
"language": "en-US"
}
]
}
} 完整的调用示例,请参见钱包服务-服务端卡片开通示例代码。
public HwWalletObject invokeHwCreatekeyMemberObject() {
HwWalletObject request = new HwWalletObject();
request.setPassTypeIdentifier("hwpass.keymember.test");
request.setPassStyleIdentifier("keyMemberModelTest");
request.setOrganizationPassId("20001");
request.setSerialNumber("20001");
Fields fields = new Fields();
fields.setCountryCode("CN");
List<ValueObject> commonFields = new ArrayList<>();
ValueObject seatNumber = new ValueObject();
seatNumber.setKey("seatNumber");
seatNumber.setValue("12A");
commonFields.add(seatNumber);
fields.setCommonFields(commonFields);
request.setFields(fields);
HttpHeaders header = constructHttpHeaders();
String baseUrl = "https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass";
String walletServerUrl = baseUrl + "/v2/key_member/instance";
HttpEntity<JSONObject> entity = new HttpEntity<>(JSONObject.parseObject(JSONObject.toJSONString(request)), header);
ResponseEntity<JSONObject> exchange =
REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.POST, entity, JSONObject.class);
return JSONObject.parseObject(exchange.getBody().toJSONString(), HwWalletObject.class);
} 华为钱包会员卡卡片的开通是基于JWE(JSON Web Encryption)方式。因此开发者业务管理服务向钱包云服务申请创建会员卡成功后,基于创建成功的会员卡serialNumber生成JWE数据,并将其返回给开发者客户端。JWE数据包含JWE Encrypted Key,iv,Ciphertext,signature,可参见如下步骤获取:
生成一个随机的CEK(Content Encryption Key)。
使用RSA-OAEP加密算法,用钱包服务器给的公钥加密CEK,生成JWE Encrypted Key。
生成JWE初始化向量。
使用AES GCM加密算法对明文部分进行加密生成密文Ciphertext,算法会随之生成128位的认证标记Authentication Tag。对以上部分分别进行base64编码。
使用开发者创建Wallet Kit服务生成的私钥对以上部分进行签名从而获取Signature。
完整的调用示例,请参见钱包服务-服务端卡片开通示例代码。
public static String generateJwe(String jwePrivateKey, String payload) {
Map<String, String> jweHeader = getHeader();
String jweHeaderEncode = getEncodeHeader(jweHeader);
String sessionKey = generateSecureRandomFactor(16);
String sessionKeyPublicKey = "MIIBojA****";
String encryptedKeyEncode = getEncryptedKey(sessionKey, sessionKeyPublicKey);
byte[] iv = AesUtil.getIvByte(12);
String ivHexStr = new String(Hex.encodeHex(iv, false));
String ivEncode = Base64.encodeBase64URLSafeString(ivHexStr.getBytes(StandardCharsets.UTF_8));
String cipherTextEncode = getCipherText(payload, sessionKey, iv);
String signature = getSignature(jwePrivateKey, sessionKey, payload, jweHeaderEncode, ivEncode);
StringBuilder stringBuilder = new StringBuilder().append(jweHeaderEncode)
.append(".")
.append(encryptedKeyEncode)
.append(".")
.append(ivEncode)
.append(".")
.append(cipherTextEncode)
.append(".")
.append(signature);
return stringBuilder.toString();
} 承载协议:HTTPS
请求方式:PUT:全量更新;PATCH:局部更新
接口方向:开发者业务管理服务->钱包云服务
接口URL:https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass/v2/{cardType}/instance/{instanceId}
数据格式:
请求消息:Content-Type: application/json;charset=UTF-8
响应消息:Content-Type: application/json;charset=UTF-8
Request Header
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 请求的数据类型,取值为:application/json;charset=UTF-8。 |
| Authorization | 是 | String | 认证信息,将获取AccessToken获取到的“access_token”的值拼接在字符串“Bearer”之后,以空格符相隔,组成“Authorization”参数的值。 |
| Accept | 是 | String | 响应的数据格式,取值为:application/json;charset=UTF-8。 |
Request Body
参见申请会员卡的请求体,如果是全量更新,与申请会员卡接口请求体相同。如果是局部更新,则只需传入需要变更的数据体。
PATCH /hmspass/v2/key_member/instance/100003 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer bKyECwrVGw********************e
Accept: application/json;charset=UTF-8
{
"fields": {
"commonFields": [
{
"value": "xxxx",
"key": "personalizedData"
}
]
}
} public HwWalletObject invokeHwCreatekeyMemberObject() {
HwWalletObject request = new HwWalletObject();
request.setPassTypeIdentifier("hwpass.keymember.test");
request.setPassStyleIdentifier("keyMemberModelTest");
request.setOrganizationPassId("20001");
request.setSerialNumber("20001");
Fields fields = new Fields();
fields.setCountryCode("CN");
List<ValueObject> commonFields = new ArrayList<>();
ValueObject seatNumber = new ValueObject();
seatNumber.setKey("seatNumber");
seatNumber.setValue("12A");
commonFields.add(seatNumber);
fields.setCommonFields(commonFields);
request.setFields(fields);
HttpHeaders header = constructHttpHeaders();
String baseUrl = "https://wallet-passentrust-drcn.cloud.huawei.com.cn/hmspass";
// 100003仅为instanceId的示例值,实际使用时请替换为真实的instanceId。
String walletServerUrl = baseUrl + "/v2/key_member/instance/100003";
HttpEntity<JSONObject> entity = new HttpEntity<>(JSONObject.parseObject(JSONObject.toJSONString(request)), header);
ResponseEntity<JSONObject> exchange =
REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.PATCH, entity, JSONObject.class);
return JSONObject.parseObject(exchange.getBody().toJSONString(), HwWalletObject.class);
}