认证与签名

Open API 使用请求头传递渠道身份和签名。每次请求都应生成新的时间戳、随机 nonce 和签名。

请求头

Header 必填 说明
yapi-version 是 版本号,例如 1.0.0
yapi-merchant 是 渠道分配的商户关键字
yapi-timestamp 是 当前时间戳,毫秒
yapi-nonce 是 随机字符串,同一时间戳不可重复使用
yapi-sign 是 签名结果,使用小写 MD5 十六进制字符串
yapi-verify 否 仅开发环境可设置为 false 以跳过签名校验;生产环境应省略或设置为 true

yapi-version 使用 1.0.0 表示 v1,使用 2.0.0 表示 v2。yapi-merchant 是渠道关键字,secret 是平台为渠道保存的私密凭证。

签名参数

签名算法

签名原文由四段内容按 + 连接:

merchant + "+" + secret + "+" + timestamp + "+" + nonce

然后计算 MD5:

const crypto = require('crypto')

const sign = crypto
  .createHash('md5')
  .update(`${merchant}+${secret}+${timestamp}+${nonce}`)
  .digest('hex')

请求示例

curl -X POST "https://dev-yapi.ytripos.com/v2/hotel/search" \
  -H "Content-Type: application/json" \
  -H "yapi-version: 2.0.0" \
  -H "yapi-merchant: your-merchant" \
  -H "yapi-timestamp: 1613465391602" \
  -H "yapi-nonce: CLgL1Rm4" \
  -H "yapi-sign: <md5-result>" \
  -d '{"stay":{"checkIn":"2026-04-15","checkOut":"2026-04-16"}}'

时间戳需要和服务端时间保持同步。服务端会校验签名、时间窗口和 nonce 的唯一性;重试请求时应重新生成时间戳、nonce 和签名。