APIリファレンス

ベースURL

すべてのエンドポイントは、単一のバージョン管理されたベースパスの下で提供されます。v1は安定版であり、破壊的変更は行われません。

/api/v1

認証

リクエストは、サインイン時に発行される短期間有効なアクセストークンで認証され、HTTP-onlyクッキーとして送信されます。有効期限が切れたトークンは自動的に更新されます。

レスポンス形式

すべてのレスポンスは同一のエンベロープを使用します。成功時のレスポンスにはdataペイロード（リストの場合はmetaも）が含まれ、エラー時には安定したcodeと人間が読めるメッセージが含まれます。

{
  "success": true,
  "message": "OK",
  "data": { },
  "meta": { "page": 1, "pageSize": 20, "total": 42 }
}

{
  "success": false,
  "code": "VALIDATION_ERROR",
  "message": "The request could not be processed."
}

規約

• ページネーション?page=1&pageSize=20
• フィルタリング?filter[status]=active
• ソート?sort=createdAt:desc

主なエンドポイント

これは代表的な一部です。常に最新の完全なリファレンスは、公開APIとともに提供されます。