クライアントフローマップ

クライアントフローマップ

目的: api.inbox-manager.com と統合するクライアントに予期されるトップレベルのシーケンスを定義します。

プライマリ フロー

1. auth.inbox-manager.com に対して認証します。
2. アカウントのコンテキストとメンバーシップを解決します。
3. IMAP/SMTP プロバイダーの資格情報を作成して検証します。
4. IMAP メタデータを email_messages に同期します。
5. オンデマンドでメッセージ本文とメッセージ部分を読み取ります。
6. アウトバウンド SMTP メッセージ タスクを送信します。
7. ジョブの監視と操作 (トリガー/リトライ/解決)。
8. 明示的にキューに入れられた作業にはタスクを使用します。
9. 操作ログを確認します。
10. サブスクリプションのライフサイクル アクションを管理します (所有者)。

エンドポイント ファミリ

• 認証: /auth/*、/oauth2/*、/.well-known/jwks.json
• アカウント/メンバー: /api/accounts*、/api/accounts/:account_id/members*
• アカウントコンテキストスイッチ: POST /api/account-views/switch
• 資格情報: /api/accounts/:account_id/provider-credentials*、/api/provider-credentials/:provider_credential_id/*
• プロバイダーのアクション:
  • POST /api/accounts/:account_id/imap/sync-mailboxes
  • POST /api/accounts/:account_id/imap/sync-messages
  • POST /api/accounts/:account_id/smtp/messages
• 電子メールのリソース:
  • /api/accounts/:account_id/emails*
  • /api/emails/:email_id
  • /api/accounts/:account_id/emails/:email_id/body
  • /api/accounts/:account_id/emails/:email_id/parts
  • /api/accounts/:account_id/emails/:email_id/parts/:part_id/content
• タスク: /api/accounts/:account_id/tasks*、/api/tasks/:task_id*
• ジョブ: /api/accounts/:account_id/jobs*、/api/jobs/:job_id*
• ログ: /api/accounts/:account_id/logs*、/api/logs/:log_id
• サブスクリプション:
  • /api/subscriptions*
  • /api/subscriptions/:subscription_id/change
  • /api/subscriptions/:subscription_id/cancel
  • /api/subscriptions/stripe/checkout-session
  • /api/subscriptions/stripe/portal-session
  • /api/subscriptions/stripe/checkout-session-sync

セキュリティへの期待

• JWT 署名検証は https://auth.inbox-manager.com/.well-known/jwks.json を使用します。
• account_id ルート パスは JWT アカウントの要求と一致する必要があります。
• app クレームのスコープはすべてのデータ アクセスです。
• 閲覧者の役割は読み取り制限があり、本文または部分のコンテンツを取得できません。
• サブスクリプション アカウントのコンテキストは JWT acc クレームから取得されます。
• auth.inbox-manager.com および api.inbox-manager.com ルートは、このサービス OpenAPI の外部にあります。