Aller au contenu principal

POST /cosmetic/create-lootbox

version 2.0.0

Créer une nouvelle 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

Les champs suivants sont attendus dans le corps de la requête :

NomTypeDansRequisDescriptionValeur par default
playerIdnumberBodyL'ID du joueur qui as ouvert la lootbox
player2IdnumberBodyL'ID du joueur a qui reçoit le cosmétiquenull
cosIdnumberBodyL'ID du cosmétique gagné
purposestringBodyExplique la manière dont il a reçut la lootbox
commentstringBodyPermet de rajouter des informations sur la lootbox
claimedboolBodySi la lootbox a été récupérerfalse

🧾 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/create-lootbox

Et dans le body mettre par exemple :

{
"playerId": 1,
"cosId": 1,
"purpose": "Achat boutique",
"comment": ""
}

📥 Exemple de réponse

Si la lootbox est bien créé (code 201) :

{
"id": 0,
"playerId": 1,
"player2Id": null,
"cosId": 1,
"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
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 accès à cette requête.

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