Aller au contenu principal

API des abonnements

Pour travailler avec les abonnements du côté de l'application cliente, trois points de terminaison sont prévus : souscription, annulation d'abonnement et récupération de la liste des abonnements actifs de l'utilisateur actuel.

Tous les points de terminaison s'exécutent au nom de l'utilisateur autorisé — l'abonnement est toujours lié au jeton avec lequel la demande a été faite.

Souscription​

Crée un nouvel abonnement pour l'utilisateur actuel sur le jeton spécifié.

Le comportement dépend du type de compte de paiement lié à l'abonnement dans les paramètres du module :

  • stripe, midtrans — un enregistrement d'abonnement est créé et un lien de paiement est retourné. L'abonnement devient actif après un prélèvement réussi de la part du fournisseur.
  • custom — l'abonnement est créé et est immédiatement considéré comme actif. Le lien de paiement n'est pas retourné, le paiement est enregistré manuellement par l'administrateur via la fiche utilisateur.

Annulation d'abonnement​

Annule immédiatement l'abonnement actif de l'utilisateur.

Le comportement dépend du type de compte de paiement :

  • stripe, midtrans — l'abonnement est annulé via l'API du fournisseur : les prélèvements automatiques sont arrêtés, le statut de l'abonnement change en canceled.
  • custom — l'annulation via l'API n'est pas disponible. Ces abonnements ne peuvent être annulés que par l'administrateur via la fiche utilisateur.
info

Une tentative d'annuler un abonnement custom via l'API renverra une erreur. Cela a été fait intentionnellement : les abonnements manuels sont gérés par l'administrateur, car les paiements pour ceux-ci se font en dehors du système.

Récupération des abonnements actifs​

Retourne un tableau de jetons des abonnements actifs de l'utilisateur actuel.

Un abonnement est considéré comme actif si :

  • Il a été souscrit avec succès.
  • Sa période actuelle n'est pas encore expirée.
  • Il n'a pas été annulé (canceled).

Si l'abonnement a expiré ou a été annulé, son jeton disparaît automatiquement de la liste. Le point de terminaison est pratique à utiliser côté client pour vérifier l'accès au contenu : si le jeton de l'abonnement requis est présent dans le tableau, l'accès est accordé.