Mapa de flujo de clientes
Propósito: definir la secuencia de nivel superior esperada para los clientes que se integran con api.inbox-manager.com.
Flujos primarios
- Autenticarse contra
auth.inbox-manager.com. - Resolver el contexto de la cuenta y la membresía.
- Cree y valide las credenciales del proveedor IMAP/SMTP.
- Sincronice metadatos de IMAP con
email_messages. - Lea el cuerpo del mensaje y las partes del mensaje a pedido.
- Enviar tareas de mensajes salientes SMTP.
- Monitorear y operar trabajos (activar/reintentar/resolver).
- Utilice tareas para trabajos en cola explícitos.
- Revisar los registros operativos.
- Gestionar acciones del ciclo de vida de la suscripción (propietario).
Familias de endpoints
- Autenticación:
/auth/*,/oauth2/*,/.well-known/jwks.json - Cuentas/miembros:
/api/accounts*,/api/accounts/:account_id/members* - Cambio de contexto de cuenta:
POST /api/account-views/switch - Credenciales:
/api/accounts/:account_id/provider-credentials*,/api/provider-credentials/:provider_credential_id/* - Acciones del proveedor:
POST /api/accounts/:account_id/imap/sync-mailboxesPOST /api/accounts/:account_id/imap/sync-messagesPOST /api/accounts/:account_id/smtp/messages
- Recursos de correo electrónico:
/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
- Tareas:
/api/accounts/:account_id/tasks*,/api/tasks/:task_id* - Trabajos:
/api/accounts/:account_id/jobs*,/api/jobs/:job_id* - Registros:
/api/accounts/:account_id/logs*,/api/logs/:log_id - Suscripciones:
/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
Expectativas de seguridad
- La verificación de firma JWT usa
https://auth.inbox-manager.com/.well-known/jwks.json. - El parámetro de ruta
account_iddebe coincidir con el claim de cuenta del JWT. - El claim
appdelimita todo el acceso a datos. - El rol
vieweres de solo lectura y no puede recuperar contenido del cuerpo ni de partes. - El contexto de cuenta para suscripciones proviene del claim JWT
acc. - Las rutas
auth.inbox-manager.comyapi.inbox-manager.comestán fuera del OpenAPI de este servicio.