1. 接口地址

• 验证卡密：POST /api/card-verify/verify
• 使用卡密：POST /api/card-verify/use
• 接口文档：GET /api/card-verify/doc

2. 认证方式

支持两种方式传递API密钥：

• HTTP Header（推荐）：X-API-Key: your-api-key
• URL参数：?api_key=your-api-key

3. 请求示例

curl -X POST "http://your-domain.com/api/card-verify/verify" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "card_secret=ABC123&openid=user123"
                                

4. 响应格式

{
  "code": 0,
  "msg": "成功信息",
  "data": {
    "card_secret": "ABC123",
    "exists": true,
    "valid": true,
    "claimed": false,
    "used": false,
    "trigger_keyword": "测试",
    "card_type": "VIP",
    "prefix": "VIP",
    "create_time": "2023-10-01 12:00:00"
  }
}
                                

5. 错误码说明

• 0 - 成功
• 400 - 请求参数错误
• 401 - API密钥不能为空
• 403 - API密钥无效/权限不足/IP限制
• 404 - 卡密不存在
• 500 - 服务器内部错误

6. 安全建议

• API密钥应妥善保管，不要在客户端代码中明文存储
• 建议定期更换API密钥
• 配置IP白名单限制访问来源
• 设置合理的请求频率限制
• 生产环境建议使用HTTPS协议