Peta Alur Klien

Peta Alur Klien

Tujuan: menentukan urutan tingkat atas yang diharapkan untuk klien yang berintegrasi dengan api.inbox-manager.com.

Alur Utama

1. Otentikasi terhadap auth.inbox-manager.com.
2. Selesaikan konteks akun dan keanggotaan.
3. Membuat dan memvalidasi kredensial penyedia IMAP/SMTP.
4. Sinkronkan IMAP metadata ke email_messages.
5. Baca isi pesan dan bagian pesan sesuai permintaan.
6. Kirim tugas pesan SMTP keluar.
7. Pantau dan operasikan pekerjaan (pemicu/coba lagi/selesaikan).
8. Gunakan tugas untuk pekerjaan antrean eksplisit.
9. Tinjau log operasional.
10. Kelola tindakan siklus hidup langganan (pemilik).

Kelompok Endpoint

• Auth: /auth/*, /oauth2/*, /.well-known/jwks.json
• Akun/anggota: /api/accounts*, /api/accounts/:account_id/members*
• Peralihan konteks akun: POST /api/account-views/switch
• Kredensial: /api/accounts/:account_id/provider-credentials*, /api/provider-credentials/:provider_credential_id/*
• Tindakan penyedia:
  • POST /api/accounts/:account_id/imap/sync-mailboxes
  • POST /api/accounts/:account_id/imap/sync-messages
  • POST /api/accounts/:account_id/smtp/messages
• Sumber daya email:
  • /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
• Tugas: /api/accounts/:account_id/tasks*, /api/tasks/:task_id*
• Pekerjaan: /api/accounts/:account_id/jobs*, /api/jobs/:job_id*
• Log: /api/accounts/:account_id/logs*, /api/logs/:log_id
• Langganan:
  • /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

Ekspektasi Keamanan

• Verifikasi tanda tangan JWT menggunakan https://auth.inbox-manager.com/.well-known/jwks.json.
• Parameter path account_id harus sesuai dengan klaim akun pada JWT.
• Klaim app mencakup semua akses data.
• Peran viewer bersifat hanya-baca dan tidak dapat mengambil konten body maupun part.
• Konteks akun langganan berasal dari klaim JWT acc.
• Rute auth.inbox-manager.com dan api.inbox-manager.com berada di luar OpenAPI layanan ini.