語言
EN繁简

文件導覽

概覽驗證與簽名Endpoint活動列表建立訂單封存訂單QR Code 解析驗證訂單核銷訂單測試流程

活動列表

此頁展示按商戶 Id 取得活動列表的接口結構。

POST/api/integrations/merchant/programs/list

按商戶 Id 取得相關活動列表。

Request 欄位

欄位
類型
必填
說明
merchantId
string
是
用來取得相關活動的商戶 Id。

Response 欄位

欄位
類型
說明
code
number
返回代碼。
success
boolean
成功取得活動列表時會出現。
programs
array
該商戶的活動列表。
message
string
可讀訊息。

回傳代碼

為了讓商戶文件及收銀員介面更簡單，Yuter 將此整合回應統一成四個頂層代碼。

代碼
意思
備註
1
成功
訂單驗證成功或已成功核銷。
2
已核銷
此訂單在本次請求前已完成核銷。
3
無效訂單
booking id 無效，或找不到相關訂單。
4
其他錯誤
認證失敗、不可核銷、商戶無權限，或其他受控錯誤。

活動列表 cURL

活動列表 endpoint 的 request 與 response。

cURL 範例

API_KEY='<raw merchant api key>'
MERCHANT_ID='<merchant id>'
TIMESTAMP=$(($(date +%s) * 1000))
NONCE=$(uuidgen)
BODY='{"merchantId":"'"$MERCHANT_ID"'"}'
PATH='/api/integrations/merchant/programs/list'
PAYLOAD="POST
$PATH
$TIMESTAMP
$NONCE
$BODY"
SIGNATURE=$(printf "%s" "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_KEY" -hex | sed 's/^.* //')

curl -X POST "https://www.yuterwellness.com$PATH" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $API_KEY" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-nonce: $NONCE" \
  -H "x-signature: $SIGNATURE" \
  -d "$BODY"

回應範例

{
  "code": 1,
  "success": true,
  "message": "Programs fetched successfully",
  "programs": [
    {
      "_id": "69ce982e96a5b33a356ab001",
      "title": "Private Merchant Test Event"
    }
  ]
}