88API88API
User GuideAI ApplicationsAPI ReferenceHelp & Support

Module Groupe

Description des fonctionnalités

Le préfixe de l'API est uniformément http(s)://<your-domain>

HTTPS doit être utilisé dans les environnements de production pour sécuriser les jetons d'authentification. HTTP n'est recommandé que pour les environnements de développement.

Une interface simple pour interroger les noms de groupes. Principalement utilisé pour les composants de sélection déroulante dans l'interface administrateur. Contrairement à l'interface de groupe côté utilisateur, elle renvoie uniquement une liste de noms et n'inclut pas d'informations détaillées telles que les ratios.

🔐 Authentification de l'administrateur

Obtenir la liste de tous les groupes

  • Nom de l'interface: Obtenir la liste de tous les groupes
  • Méthode HTTP: GET
  • Chemin: /api/group/
  • Authentification requise: Administrateur
  • Description de la fonction: récupère une liste de noms pour tous les groupes d'utilisateurs du système, utilisée pour la configuration de l'administrateur et la sélection des composants frontaux.

💡 Exemple de demande:

const response = await fetch('/api/group/', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "success": true,
  "message": "",
  "data": [
    "default",
    "vip",
    "premium",
    "enterprise"
  ]
}

❗ Exemple de réponse en cas d'échec:

{
  "success": false,
  "message": "Failed to retrieve group list"
}

🧾 Description du champ:

data (Array): Une liste de noms de groupes, contenant les noms de tous les groupes d'utilisateurs configurés dans le système.