メインコンテンツまでスキップ

REST API v2 概要

FeedbackPulse SaaSは、テナントデータへのプログラムアクセスのためのRESTful API（v2）を提供します。フィードバックを自社アプリに統合したり、ダッシュボードを構築したり、ワークフローを自動化するために使用できます。

ベースURL​

https://yourdomain.com/api/v2

認証​

すべてのAPIリクエストにはBearerトークン（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/configWebhook設定の取得
PUT/api/v2/webhooks/configWebhook設定の更新
GET/api/v2/webhooks/logsWebhook配信ログの表示

レスポンス形式​

すべてのレスポンスはJSON形式です：

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

エラーレスポンス​

{
  "error": "Unauthenticated.",
  "status": 401
}
ステータスコード意味
200成功
201作成完了
400不正なリクエスト（バリデーションエラー）
401未認証（無効または欠落したAPIキー）
403禁止（権限不足）
404見つかりません
429リクエスト過多（レート制限）
500サーバーエラー

詳細を見る​