IM
TH
หน้าเอกสาร
เมนู
คู่มือ

แผนที่การไหลของลูกค้า

กำหนดลำดับระดับบนสุดที่คาดหวังสำหรับไคลเอ็นต์ที่ผสานรวมกับ `api.inbox-manager.com`

inbox-manager client-flow

แผนที่การไหลของลูกค้า

วัตถุประสงค์: กำหนดลำดับระดับบนสุดที่คาดหวังสำหรับลูกค้าที่ผสานรวมกับ 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 ของบริการนี้