REST API v2 概述

FeedbackPulse SaaS 提供 RESTful API（v2），支持以编程方式访问您的租户数据。可用于将反馈集成到您自己的应用中、构建仪表板或自动化工作流。

---

基础 URL

https://yourdomain.com/api/v2

---

身份验证

所有 API 请求均需要 Bearer token（API 密钥）：

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://yourdomain.com/api/v2/submissions

获取 API 密钥

1. 登录您的租户仪表板
2. 前往设置 > API 密钥
3. 点击创建 API 密钥
4. 立即复制该密钥（仅显示一次！）

API 密钥以 SHA256 哈希形式存储，原始密钥无法恢复。

套餐要求： API 访问需要您的套餐中包含 api_access 功能开关。

---

速率限制

限制	值
每租户每分钟请求数	60

每次响应中都包含速率限制相关头信息：

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

---

可用端点

方法	端点	说明
GET	/api/v2/submissions	提交列表
GET	/api/v2/submissions/{id}	获取单条提交
POST	/api/v2/submissions	创建提交
GET	/api/v2/products	产品列表
POST	/api/v2/products	创建产品
GET	/api/v2/campaigns	活动列表
POST	/api/v2/campaigns	创建活动
GET	/api/v2/webhooks/config	获取 webhook 配置
PUT	/api/v2/webhooks/config	更新 webhook 配置
GET	/api/v2/webhooks/logs	查看 webhook 投递日志

---

响应格式

所有响应均为 JSON 格式：

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

错误响应

{
  "error": "Unauthenticated.",
  "status": 401
}

状态码	含义
200	成功
201	已创建
400	请求错误（验证失败）
401	未授权（API 密钥无效或缺失）
403	禁止访问（权限不足）
404	未找到
429	请求过多（已触发速率限制）
500	服务器错误

---

深入了解

• 身份验证 — API 密钥详情
• 提交 API — 创建和列出反馈
• 产品 API — 管理产品
• 活动 API — 管理活动
• Webhooks — 实时事件通知