Carte de flux de clients

Carte de flux client

Objectif : définir la séquence de niveau supérieur attendue pour les clients intégrant api.inbox-manager.com.

Flux primaires

1. Authentifiez-vous auprès de auth.inbox-manager.com.
2. Résolvez le contexte du compte et l’adhésion.
3. Créez et validez les informations d’identification du fournisseur IMAP/SMTP.
4. Synchronisez les métadonnées IMAP dans email_messages.
5. Lisez le corps et les parties du message à la demande.
6. Envoyez des tâches de message SMTP sortant.
7. Surveiller et exécuter les tâches (déclencher/réessayer/résoudre).
8. Utilisez des tâches pour le travail explicite en file d’attente.
9. Consultez les journaux opérationnels.
10. Gérer les actions du cycle de vie de l’abonnement (propriétaire).

Familles de points de terminaison

• Authentification : /auth/*, /oauth2/*, /.well-known/jwks.json
• Comptes/membres : /api/accounts*, /api/accounts/:account_id/members*
• Changement de contexte de compte : POST /api/account-views/switch
• Identifiants : /api/accounts/:account_id/provider-credentials*, /api/provider-credentials/:provider_credential_id/*
• Actions du fournisseur :
  • POST /api/accounts/:account_id/imap/sync-mailboxes
  • POST /api/accounts/:account_id/imap/sync-messages
  • POST /api/accounts/:account_id/smtp/messages
• Ressources de courrier électronique :
  • /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
• Tâches : /api/accounts/:account_id/tasks*, /api/tasks/:task_id*
• Emplois : /api/accounts/:account_id/jobs*, /api/jobs/:job_id*
• Journaux : /api/accounts/:account_id/logs*, /api/logs/:log_id
• Abonnements :
  • /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

Attentes en matière de sécurité

• La vérification de la signature JWT utilise https://auth.inbox-manager.com/.well-known/jwks.json.
• account_id Le chemin de la route doit correspondre à la revendication du compte JWT.
• La revendication app couvre tous les accès aux données.
• Le rôle de spectateur est limité en lecture et ne peut pas récupérer le contenu du corps ou des parties.
• Le contexte du compte d’abonnement provient de la réclamation JWT acc.
• Les routes auth.inbox-manager.com et api.inbox-manager.com sont en dehors de ce service OpenAPI.