Aller au contenu principal

GET /badge/get-badges

version 2.0.0

Récupérer les informations de tous les badges.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

  • Corail
  • Zelta
  • Axel
  • Site

🧾 Paramètres

Aucun paramètre n'est requis pour cette requête.

🧾 Réponse

Les données que l'API retournera avec le succès de la requête :

NomTypeNullableDescription
idnumberL'ID du grade
namestringLe nom du grade à créer
descriptionstringDescription du badge
raritystringRareté du badge (ex. commun, rare, etc.)
texturestringURL de l’image du badge
obtainableboolBadge obtenable hors event ?

📤 Exemple de requête

http://0.0.0.0/api/badge/get-badges

📥 Exemple de réponse

Si des badges sont trouvés (code 200) :

[
{
"id": 1,
"name": "Développeur",
"description": "Avoir le grade développeur.",
"rarity": "Légendaire",
"texture": "badge_developpeur",
"obtainable": false
},
{
"id": 2,
"name": "Modérateur",
"description": "Avoir le grade modérateur.",
"rarity": "Légendaire",
"texture": "badge_modo",
"obtainable": false
},
{
"id": 3,
"name": "Administrateur",
"description": "Avoir le grade administrateur.",
"rarity": "Légendaire",
"texture": "badge_admin",
"obtainable": false
},
{
"id": 4,
"name": "Fondateur",
"description": "Avoir le grade fondateur.",
"rarity": "Légendaire",
"texture": "badge_fondateur",
"obtainable": false
},
{
"id": 5,
"name": "Partenaire",
"description": "Avoir le grade partenaire.",
"rarity": "Légendaire",
"texture": "badge_partenaire",
"obtainable": false
},
{
"id": 6,
"name": "VIP",
"description": "Avoir le grade VIP.",
"rarity": "Légendaire",
"texture": "badge_vip",
"obtainable": false
},
{
"id": 7,
"name": "Ami des admins",
"description": "Être ami avec un des administrateurs du serveur.",
"rarity": "Légendaire",
"texture": "badge_amisadmins",
"obtainable": true
}
]
info

Si aucun badge n'est trouvé, l'API retourne un tableau vide.

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
500Internal Server ErrorErreur interne du serveur
Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

{
"message": "Access Denied",
"code": 403
}