跳到主要内容

API 文档页面

FeedbackPulse 提供交互式 API 文档页面,让租户可以浏览和测试可用的接口端点。


访问 API 文档

从租户仪表板进入 /api-docs 即可查看完整的 API 参考文档。


接口分组

接口按资源类型分组组织:

资源说明
Submissions(提交记录)创建、读取、更新和管理反馈提交记录
Products(产品)管理产品及其配置
Campaigns(活动)创建和管理反馈活动
Webhooks配置和管理 Webhook 订阅

接口详情

每个接口条目显示以下信息:

字段说明
HTTP 方法请求方法(GETPOSTPUTDELETE
URL完整的接口路径
参数必填和可选参数,包含类型和说明
请求示例示例请求体或查询参数
响应示例含状态码的示例 JSON 响应

认证

API 文档页面包含认证说明。所有 API 请求均需在请求头中传入 API 密钥:

Authorization: Bearer {your-api-key}

API 密钥可在租户设置页面中生成。


一键复制

每个接口均提供预构建的 cURL 命令,点击即可复制到剪贴板,方便直接在终端中测试接口。


下一步