Gestion Des Plans

Consultation des plans

Cette section permet de récupérer la liste complète des plans disponibles dans le système. Chaque plan contient des informations telles que le nom, le prix, la durée et les avantages associés. C'est une requête généralement publique ou accessible aux utilisateurs connectés.

Endpoint: GET /api/plans/

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >

Paramètres (Query):

Champ	Type	Obligatoire	Description
status	string	Non	Etat du plan `pending` `active` `rejected` `expired`

Exemple de Réponse:

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
      {
        "id": 2,
        "balance": 10,
        "sent": 10,
        "brand_name": "HOGI",
        "status": "pending",
        "details": null,
        "created_at": "2025-08-22T15:44:35.001805Z",
        "user": 1
      },
      {
        "id": 3,
        "balance": 110,
        "sent": 46,
        "brand_name": "NTABARIZA",
        "status": "active",
        "details": null,
        "created_at": "2025-08-22T15:45:01.513219Z",
        "user": 2
      }
    ]
}

Création d'un plan

La création d'un plan permet à un administrateur ou à un utilisateur autorisé d'ajouter un nouveau plan d'abonnement au système. Chaque plan peut comporter un nom, un prix, une durée et une description afin de définir les différentes offres proposées par le service HOGI-SMS.

Endpoint: POST /api/plans/

Authentification:

Requise - Un jeton Bearer doit être envoyé dans l'en-tête :

Authorization: Bearer < votre-jeton >

Paramètres (Query):

Nom	Type	Obligatoire	Description
brand_name	string	Oui	Nom de la marque ou du plan. Ce champ est obligatoire et ne peut dépasser 16 caractères.
alert_phone_number	string	Oui	Numéro de téléphone de l'utilisateur qui recevra les alertes. Ce champ est obligatoire et doit être un numéro de téléphone valide.

Exemple de requête:

{
    "brand_name": "Premium",
    "alert_phone_number": "61069606"
}

Exemple de Réponse:

{
    "id": 1,
    "balance": 100,
    "sent": 3,
    "brand_name": "HOGI",
    "alert_phone_number": "61069606",
    "status": "active",
    "details": null,
    "created_at": "2025-11-14T14:52:33.734995Z",
    "user": 1
},