IM
ZH-CN
文档首页
菜单
指南

客户流程图

定义与“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 之外。