Aller au contenu principal

Abonnements aux événements

Les marketplace apps installées peuvent s’abonner à des types d’événements approuvés via le framework d’apps marchand.

Famille de routes implémentée​

Les routes actuelles incluent :

  • GET /api/v1/merchant/apps/installations/{installationId}/event_subscription
  • POST /api/v1/merchant/apps/installations/{installationId}/event_subscription

Des chemins marchands compatibles hérités peuvent aussi être disponibles sous api/merchant/apps/*.

Contenu d’un abonnement​

Un abonnement aux événements d’app marchande inclut :

  • l’identifiant d’installation
  • le statut activé ou désactivé
  • les types d’événements approuvés
  • un JSON de filtres optionnel

Récupérer l’abonnement actuel​

GET /api/v1/merchant/apps/installations/{installationId}/event_subscription

Si aucun abonnement n’existe encore, le service retourne une vue par défaut désactivée pour l’installation.

Mettre à jour un abonnement​

POST /api/v1/merchant/apps/installations/{installationId}/event_subscription

Les champs de requête typiques incluent :

  • enabled
  • event_types
  • filters_json

Règles de validation​

Le backend valide :

  • la propriété de l’installation
  • l’appartenance du type d’événement à la liste autorisée de la plateforme
  • l’approbation du type d’événement pour l’app spécifique
  • la validité JSON des filtres

Note opérationnelle​

Ce flux est à portée marchande et lié à une installation d’app existante. Il ne doit pas être documenté comme une API générique publique d’abonnement à un event bus.

Sections liées​