API ドキュメントページ
FeedbackPulse は、テナントが利用可能なエンドポイントを探索・テストできるインタラクティブな API ドキュメントページを提供しています。
API ドキュメントへのアクセス
テナントダッシュボードから /api-docs に移動して、完全な API リファレンスを表示します。
エンドポイントのグループ分け
エンドポイントはリソース別に整理されています：
| リソース | 説明 |
|---|---|
| Submissions（投稿） | フィードバック投稿の作成、読み取り、更新、管理 |
| Products（製品） | 製品とその設定の管理 |
| Campaigns（キャンペーン） | フィードバックキャンペーンの作成と管理 |
| Webhooks | Webhook サブスクリプションの設定と管理 |
エンドポイントの詳細
各エンドポイントエントリには以下の情報が表示されます：
| フィールド | 説明 |
|---|---|
| HTTP メソッド | リクエストメソッド（GET、POST、PUT、DELETE） |
| URL | 完全なエンドポイントパス |
| パラメーター | タイプと説明付きの必須および任意パラメーター |
| リクエスト例 | サンプルリクエストボディまたはクエリパラメーター |
| レスポンス例 | ステータスコード付きのサンプル JSON レスポンス |
認証
API ドキュメントページには認証手順が含まれています。すべての API リクエストには、リクエストヘッダーに API キーが必要です：
Authorization: Bearer {your-api-key}
API キーはテナントの Settings ページから生成できます。
クリップボードへのコピー
各エンドポイントには、ワンクリックでクリップボードにコピーできるビルド済みの cURL コマンドが含まれており、ターミナルからエンドポイントを簡単にテストできます。