REST API

REST APIは /api/v1 配下で利用でき、スクリプト、内部サービス、CI、データの書き出し、その他のサーバー側自動化に適しています。

保護されたエンドポイントには、個人用APIトークンが必要です。リクエストは、トークンを発行したユーザーとして実行され、同じ役割と権限のチェックを受けます。

認証

トークンはHTTPヘッダーで次のように送信します：

Authorization: Bearer <token>

トークンの発行、保存、失効の方法については、APIトークンの記事を参照してください。

curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"

{org}を組織IDに置き換えてください。特定のエンドポイントのパラメータ、レスポンス形式、エラーコードについては、完全な仕様を参照してください。

APIには過負荷を防ぐためのレート制限が設けられています。

制限を超えると、サーバーはHTTP 429 Too Many Requests を返します。レスポンスには Retry-After ヘッダー（再試行までの秒数）と次のエラーボディが含まれます。

{
  "status": 429,
  "message": "リクエストが多すぎます。30秒後にもう一度お試しください。",
  "errors": {}
}