MCP System Backend

🚀 システム API ドキュメント

このシステムは以下の核心モジュールを含んでいます。

1. ユーザー管理（User Management）
2. パートナー管理（Partner Management）
3. 宅配回収管理（Pickup Management）
4. 注文処理（Order Processing）
5. 取引記録管理（Transaction Record Management）

🚀 クイックスタート

ユーザー登録とログイン

登録API

• リクエスト方式: POST
• パス: /api/v1/auth/register

リクエストパラメータ:

• name: ユーザー名
• email: ユーザーのメールアドレス (一意である必要があります)
• password: ユーザーパスワード
• role: ユーザーロール（オプション、デフォルトは "user"）

ログインAPI

• リクエスト方式: POST
• パス: /api/v1/auth/login

リクエストパラメータ:

• email: ユーザーのメールアドレス
• password: ユーザーパスワード

パートナー管理

パートナーの作成

• リクエスト方式: POST
• パス: /api/v1/partners

リクエストパラメータ:

• name: パートナー企業名
• email: 連絡用メールアドレス (一意である必要があります)
• password: パートナーのパスワード
• role: ロール（"MCP" または "PickupPartner"）

宅配回収管理

宅配回収タスクの作成

• リクエスト方式: POST
• パス: /api/v1/pickups

リクエストパラメータ:

• title: 回収タイトル
• description: 回収説明
• address: 回収住所
• date: 予定日時
• status: ステータス（"pending", "completed", "failed"）
• assignedTo: 担当者ID（ユーザーまたはパートナー）

注文処理

注文の作成

• リクエスト方式: POST
• パス: /api/v1/orders

リクエストパラメータ:

• orderNumber: 注文番号
• items: 注文アイテムの配列。以下を含みます。
  • product: 商品名
  • quantity: 数量
  • price: 単価
  • total: 合計金額
• totalAmount: 注文総額
• shippingAddress: 配送先住所
• paymentMethod: 支払い方法
• status: ステータス（"pending", "processing", "completed", "cancelled"）

取引記録管理

取引記録の作成

• リクエスト方式: POST
• パス: /api/v1/transactions

リクエストパラメータ:

• type: タイプ（"deposit", "withdrawal", "transfer"）
• amount: 金額
• description: 説明
• status: ステータス（"completed", "failed", "pending"）

認証フロー

1. 登録/ログイン:
   • ユーザーまたはパートナーは対応するエンドポイントを通じて登録またはログインします。
   • サーバーは JWT トークンを返します。
2. トークンの使用:
   • すべての保護されたリクエストには、以下の形式でトークンを含めます。

   Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
   

3. ロールベースのアクセス制御:
   • 一部のエンドポイントはユーザーのロールに基づいて制限されています。
   • システムがサポートするロールには "MCP" と "PickupPartner" が含まれます。
   • 未承認のアクセス試行は拒否され、403 エラーが返されます。

📚 ドキュメント

データモデル

ユーザー（User）

{
  name: String,         // ユーザー名
  email: String,        // ユーザーのメールアドレス (一意)
  password: String,     // 暗号化されたパスワード
  role: String,         // 承認されたロール
  status: String,       // 'ACTIVE', 'INACTIVE'
  createdAt: Date,
  updatedAt: Date
}

パートナー（Partner）

{
  name: String,          // パートナー企業名
  email: String,         // 連絡用メールアドレス (一意)
  password: String,      // 暗号化されたパスワード
  role: String,          // 'MCP', 'PickupPartner'
  walletBalance: Number, // 現在のウォレット残高
  createdAt: Date,
  updatedAt: Date
}

宅配回収（Pickup）

{
  title: String,         // 回収タイトル
  description: String,   // 回収説明
  address: String,       // 回収住所
  date: Date,            // 予定日時
  status: String,        // 'pending', 'completed', 'failed'
  assignedTo: ObjectId,  // 担当者参照（ユーザー/パートナー）
  createdAt: Date,
  updatedAt: Date
}

注文（Order）

{
  orderNumber: String,   // 注文番号
  items: Array,          // 注文アイテムの配列。以下を含みます。
    - product: String   // 商品名
    - quantity: Number  // 数量
    - price: Number     // 単価
    - total: Number     // 合計金額
  totalAmount: Number,   // 注文総額
  shippingAddress: String,// 配送先住所
  paymentMethod: String,// 支払い方法
  status: String,        // ステータス（"pending", "processing", "completed", "cancelled"）
  createdAt: Date,
  updatedAt: Date
}

取引記録（Transaction）

{
  type: String,          // タイプ（"deposit", "withdrawal", "transfer"）
  amount: Number,        // 金額
  description: String,   // 説明
  status: String,        // ステータス（"completed", "failed", "pending"）
  createdAt: Date,
  updatedAt: Date
}