API Documentation Page
FeedbackPulse provides an interactive API documentation page so tenants can explore and test available endpoints.
Accessing API Docs
导航到 /api-docs from the 租户仪表板 to view the full API reference.
Endpoint Grouping
Endpoints are organized by resource:
| Resource | 说明 |
|---|---|
| 提交 | Create, read, update, and manage feedback submissions |
| 产品 | Manage products and their configurations |
| 活动 | Create and manage feedback campaigns |
| Webhooks | Configure and manage webhook subscriptions |
Endpoint Details
Each endpoint entry displays the following information:
| 字段 | 说明 |
|---|---|
| HTTP Method | The request method (GET, POST, PUT, DELETE) |
| URL | The full endpoint path |
| 参数 | Required and optional parameters with types and descriptions |
| Example Request | Sample request body or query parameters |
| Example Response | Sample JSON response with status code |
Authentication
The API docs page includes authentication instructions. All API requests require an API key passed in the request header:
Authorization: Bearer {your-api-key}
API 密钥 can be generated from the tenant 设置 page.
Copy-to-Clipboard
Each endpoint includes a pre-built cURL command that can be copied to the clipboard with a single click, making it easy to test endpoints from the terminal.