文档管理中心
API参考钱包服务REST开发者调用接口卡券创建、查询、修改接口登机牌接口新增登机牌个人化实例

新增登机牌个人化实例

功能介绍

添加登机牌个人化实例到钱包服务器。

场景描述

开发者可以调用该API,将某一用户的登机牌实例添加到钱包服务器。使用此接口后,需发送瘦JWE绑定用户。另外可以发送JWE直接把个人化实例添加到服务器并且绑定用户,而不使用此接口。

使用约束

需在华为AGC网站上创建应用并申请卡券对应的服务。需先添加个人化实例所属的卡券模板到华为钱包服务器。

接口原型

承载协议

HTTPS POST

接口方向

开发者服务器->华为钱包服务器

接口URL

{url}/hmspass/v1/flight/instance

{url}变量需要开发者根据服务器所属区域自行选择,请参见钱包服务器地址

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

展开

参数

是否必选

参数类型

描述

Authorization

String

鉴权码。获取方式详见基于OAuth 2.0开放鉴权,请使用“客户端模式”。“client_id”和“client_secret”即为开发者在华为AGC网站上创建应用后获取的“App ID”和“App key”。将获取到的“access_token”的值拼接在字符串“Bearer”之后,以空格符相隔,组成“Authorization”参数的值。

Content-Type

String

固定值:“application/json;charset=utf-8”。

Accept

String

固定值:“application/json;charset=utf-8”。

Request Body

展开

参数

是否必选

参数类型

描述

详见HwWalletObject参数描述

HwWalletObject

待添加的卡券个人化实例

请求示例

收起
自动换行
深色代码主题
复制
  1. POST /hmspass/v1/flight/instance HTTP/1.1
  2. Content-Type: application/json;charset=utf-8
  3. Authorization: Bearer ***
  4. Host: wallet-passentrust-drcn.cloud.huawei.com.cn
  5. Accept: application/json;charset=utf-8
  6. {
  7. "organizationPassId": "5623489692",
  8. "passTypeIdentifier": "hwpass.com.huawei.wallet.flight.test",
  9. "passStyleIdentifier": "flightModelTest",
  10. "serialNumber": "20001",
  11. "fields": {
  12. "status": {
  13. "state": "active",
  14. "effectTime": "2019-11-13T00:00:00.111Z",
  15. "expireTime": "2020-11-20T00:00:00.111Z"
  16. },
  17. "barCode": {
  18. "text": "5623489692",
  19. "type": "qrCode",
  20. "value": "5623489692",
  21. "encoding": "UTF-8"
  22. },
  23. "commonFields": [
  24. {
  25. "key": "seatNumber",
  26. "value": "12A"
  27. },
  28. {
  29. "key": "passengerName",
  30. "value": "Wang Xiao"
  31. },
  32. {
  33. "key": "boardingSequence",
  34. "value": "1"
  35. },
  36. {
  37. "key": "flightClass",
  38. "value": "First Class"
  39. }
  40. ],
  41. "appendFields": [
  42. {
  43. "key": "confirmationNumber",
  44. "value": "ITK919"
  45. }
  46. ]
  47. }
  48. }

响应参数

错误码为200时:

展开

参数

参数类型

描述

详见HwWalletObject参数描述

HwWalletObject

已添加的卡券实例

响应示例

收起
自动换行
深色代码主题
复制
  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. {
  4. "organizationPassId": "5623489692",
  5. "passTypeIdentifier": "hwpass.com.huawei.wallet.flight.test",
  6. "passStyleIdentifier": "flightModelTest",
  7. "serialNumber": "20001",
  8. "fields": {
  9. "status": {
  10. "state": "active",
  11. "effectTime": "2019-11-13T00:00:00.111Z",
  12. "expireTime": "2020-11-20T00:00:00.111Z"
  13. },
  14. "commonFields": [
  15. {
  16. "key": "seatNumber",
  17. "value": "12A"
  18. },
  19. {
  20. "key": "passengerName",
  21. "value": "Wang Xiao"
  22. },
  23. {
  24. "key": "boardingSequence",
  25. "value": "1"
  26. },
  27. {
  28. "key": "flightClass",
  29. "value": "First Class"
  30. }
  31. ],
  32. "appendFields": [
  33. {
  34. "key": "confirmationNumber",
  35. "value": "ITK919"
  36. }
  37. ],
  38. "barCode": {
  39. "text": "5623489692",
  40. "type": "qrCode",
  41. "value": "5623489692",
  42. "encoding": "UTF-8"
  43. }
  44. }
  45. }

错误码

详见错误码

调用示例

收起
自动换行
深色代码主题
复制
  1. public HwWalletObject postHwWalletObjectToWalletServer(String url, HwWalletObject hwWalletObject) {
  2. // Construct the http header.
  3. HttpHeaders header = constructHttpHeaders();
  4. // Construct the http body.
  5. String body = CommonUtil.toJson(hwWalletObject);
  6. JSONObject jsonObj = JSONObject.parseObject(body);
  7. System.out.println("Request JSON : " + jsonObj);
  8. // Construct the http URL.
  9. String baseUrl = ConfigHelper.instants().getValue("walletServerBaseUrl");
  10. String walletServerUrl = baseUrl + url;
  11. // Send the http request and get response.
  12. HttpEntity<JSONObject> entity = new HttpEntity<>(jsonObj, header);
  13. ResponseEntity<HwWalletObject> exchange =
  14. REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.POST, entity, HwWalletObject.class);
  15. // Return the posted wallet model.
  16. return exchange.getBody();
  17. }
在 API参考 中进行搜索
请输入您想要搜索的关键词