Weba 身分驗證 API.md
77 additions, 0 deletions
| ... | ... | @@ -1 +1,78 @@ |
| 1 | +## 版本紀錄 | |
| 2 | +| 版本 | 說明 | 日期 | 異動者 | | |
| 3 | +| ---| ---| ---| --- | | |
| 4 | +| 1.0 | 初版 | 2025/11/28 | [@Yichou Lin](#user_mention#54197113) | | |
| 5 | + | |
| 6 | +* * * | |
| 7 | +## 說明 | |
| 8 | +* 服務名稱：Weba 身分驗證 API | |
| 9 | +* 服務說明：會員多重身分驗證 + Weba取Token | |
| 10 | +* Reference Table：`ACCOUNT` `ORCA_MEMBERSHIP` | |
| 11 | +* Request / Response 是否加密： 否 | |
| 12 | + | |
| 13 | +## HTTP REQUEST | |
| 14 | + | |
| 15 | +```powershell | |
| 16 | +curl GET {EndPoint}/mds/mvs/member/identities/validation?identityTypes=CUB,ORCA | |
| 17 | +``` | |
| 18 | + | |
| 19 | +| Header | Description | | |
| 20 | +| ---| --- | | |
| 21 | +| Content-Type | application/json | | |
| 22 | + | |
| 23 | +### REQUEST HEADER | |
| 24 | + | |
| 25 | +| level | key | type | required | field name | example | | |
| 26 | +| ---| ---| ---| ---| ---| --- | | |
| 27 | +| 1 | X-Auth-Token | String | true | session token | ex. Gy6u-SIDe7N3zCrPqaG0YcJ+.a5b00e2c-3334-3acd-9c37 | | |
| 28 | + | |
| 29 | +## URL PARAMETER | |
| 30 | + | |
| 31 | +| level | key | type | required | field name | example | | |
| 32 | +| ---| ---| ---| ---| ---| --- | | |
| 33 | +| 1 | identityTypes | String | true | 身份類型`CUB` `ORCA`<br>用逗號隔開 | CUB,ORCA | | |
| 34 | + | |
| 35 | +### RESPONSE BODY | |
| 36 | + | |
| 37 | +| level | parameters | datatype | Required field | Field name | Description / example | | |
| 38 | +| ---| ---| ---| ---| ---| --- | | |
| 39 | +| 1 | success | Boolean | true | 是否成功 | | | |
| 40 | +| 1 | errorCode | String | false | 錯誤代碼 | | | |
| 41 | +| 1 | message | String | false | 錯誤訊息 | | | |
| 42 | +| 1 | values | JsonObject | true | 成功Response內容 | | | |
| 43 | +| 2 | allChecksPassed<br> | Boolean | true | 身份驗證是否全數通過<br> | true | | |
| 44 | +| 2 | results<br> | Array<`Result`> | true | 身份驗證結果 `Result` | | | |
| 45 | + | |
| 46 | +## Result | |
| 47 | + | |
| 48 | +| level | parameters | datatype | Required field | Field name | Description / example | | |
| 49 | +| ---| ---| ---| ---| ---| --- | | |
| 50 | +| 3 | type | String | true | 驗證身份類別 | ORCA | | |
| 51 | +| 3 | passed | Boolean | true | 此身份是否通過 | false | | |
| 52 | +| 3 | message | String | true | 此身份驗證訊息 | 非小樹會員 | | |
| 53 | + | |
| 54 | +## RESPONSE BODY - json format | |
| 55 | + | |
| 56 | +```json | |
| 57 | +{ | |
| 58 | + "success": true, | |
| 59 | + "errorCode": null, | |
| 60 | + "message": null, | |
| 61 | + "values": { | |
| 62 | + "allChecksPassed": false, | |
| 63 | + "results": [ | |
| 64 | + { | |
| 65 | + "type": "ORCA", | |
| 66 | + "passed": true, | |
| 67 | + "message": null | |
| 68 | + }, | |
| 69 | + { | |
| 70 | + "type": "CUB", | |
| 71 | + "passed": false, | |
| 72 | + "message": "非國泰卡友" | |
| 73 | + } | |
| 74 | + ] | |
| 75 | + } | |
| 76 | +} | |
| 77 | +``` |