Aller au contenu principal

GET /cosmetic/get-cosmetic

version 2.0.0

Récupérer les informations d’un cosmétique.

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 :

NomTypeDansRequisDescription
idnumberURLL’identifiant unique du cosmetic

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id du badge
namestringLe nom du cosmetic
typestringLe type du cosmetic
raritystringLa rareté du cosmetic
game stringLe jeu où est le cosmetic
argumentFrstringLa description du cosmetic en Français
argumentEnstringLa description du cosmetic en Anglais
imagestringLe chemin de l'image dans le texture pack
lootboxboolSi il est obtensible dans les lootboxs
pricenumberDéfinie le prix dans la boutique
descriptionstringDéfini la description du cosmetic
collectionstringDéfini la collection
renderstringDéfini l'affichage 3D
permanentboolDéfini s'il est permanent

📤 Exemple de requête

http://0.0.0.0/api/cosmetic/get-cosmetic?id=7

📥 Exemple de réponse

Si le cosmétique est trouvé (code 200) :

{
"id": 7,
"name": "arc",
"type": "Bow",
"rarity": "Légendaire",
"game" : "infecte",
"argumentFr": "Un arc enchanté !",
"argumentEn": "An enchanted bow!",
"image": "arc.png",
"lootbox": true,
"price": 200,
"description": null,
"collection": null,
"render": null,
"permanent": false
}

⛔ 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 cosmétic n'a pas été trouvé dans la base de données.

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