Aller au contenu principal

GET /cosmetic/get-lootbox

version 2.0.0

Récupérer les informations d’une lootbox.

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
  • Site

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
idnumberURLL’id unique de la lootbox

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID de la lootbox
playerIdnumberL'ID du joueur qui as ouvert la lootbox
player2IdnumberL'ID du joueur a qui reçoit le cosmétique
cosIdnumberL'ID du cosmétique gagné
purposestringExplique la manière dont il a reçut la lootbox
commentstringPermet de rajouter des informations sur la lootbox
claimedboolSi la lootbox a été récupérer

📤 Exemple de requête

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

📥 Exemple de réponse

Si la lootbox est trouvé (code 200) :

{   
"id": 7,
"playerId": 1,
"player2Id": null,
"cosId": 3,
"purpose": "Achat boutique",
"comment": "",
"claimed": 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 la lootbox n'a pas été trouvé dans la base de données.

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