IM
ZH-TW
文件首頁
選單
指南

客戶流程圖

定義與「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.comapi.inbox-manager.com 路由在此服務 OpenAPI 之外。