语言
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"
    }
  ]
}