POST /cosmetic/create-lootbox
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 :
| Nom | Type | Dans | Requis | Description | Valeur par default |
|---|---|---|---|---|---|
playerId | number | Body | ✅ | L'ID du joueur qui as ouvert la lootbox | ❌ |
player2Id | number | Body | ❌ | L'ID du joueur a qui reçoit le cosmétique | null |
cosId | number | Body | ✅ | L'ID du cosmétique gagné | ❌ |
purpose | string | Body | ✅ | Explique la manière dont il a reçut la lootbox | ❌ |
comment | string | Body | ✅ | Permet de rajouter des informations sur la lootbox | ❌ |
claimed | bool | Body | ❌ | Si la lootbox a été récupérer | false |
🧾 Réponse
Les données que l'API retournera avec le succès de la requête :
| Nom | Type | Nullable | Description |
|---|---|---|---|
id | number | ❌ | L'ID de la lootbox |
playerId | number | ❌ | L'ID du joueur qui as ouvert la lootbox |
player2Id | number | ✅ | L'ID du joueur a qui reçoit le cosmétique |
cosId | number | ❌ | L'ID du cosmétique gagné |
purpose | string | ❌ | Explique la manière dont il a reçut la lootbox |
comment | string | ❌ | Permet de rajouter des informations sur la lootbox |
claimed | bool | ❌ | Si 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 HTTP | Description | Cause possible |
|---|---|---|
| 400 | Bad Request | Paramètres manquants ou invalides |
| 401 | Unauthorized | Clé API manquante ou invalide |
| 403 | Forbidden | Droits insuffisants pour utiliser la requête |
| 500 | Internal Server Error | Erreur 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
| Nom | Type | Description |
|---|---|---|
code | number | Le code d'erreur que retourne la requête |
message | string | Le 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
}