Aller au contenu principal

GET /badge/get-badge

version 2.0.0

Récupérer les informations d’un badge.

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

Le paramètre suivant est requis dans l’URL pour identifier le badge :

NomTypeDansRequisDescriptionValeur par default
badgeIdnumberURLL’identifiant unique du badge

🧾 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-badge?badgeId=7

📥 Exemple de réponse

Si le badge est trouvé (code 200) :

{
"id": 7,
"name": "Ami des admins",
"description": "Être ami avec un des administrateurs du serveur.",
"rarity": "Légendaire",
"texture": "badge_amisadmins",
"obtainable": true
}

⛔ 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
404Not foundEntité introuvable
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 404 Not found :

Ici par exemple, l'erreur 404 signifie que le badge n'a pas été trouvé dans la base de données.

{
"message": "No value present",
"code": 404
}