Aller au contenu principal

POST /cosmetic/create-cosmetic

version 2.0.0

Créer un nouveau 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
  • Site

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
namestringBodyLe nom du cosmetic
typestringBodyLe type du cosmetic
raritystringBodyLa rareté du cosmetic
gamestringBodyLa jeu ou est le cosmetic
argumentFrstringBodyLa description du cosmetic en Français
argumentEnstringBodyLa description du cosmetic en Anglais
imagestringBodyLe chemin de l'image dans le texture pack"default.png"
lootboxboolBodySi il est obtenable dans les lootboxsfalse
pricenumberBodyDéfinie le prix dans la boutique0
descriptionstringBodyDéfini la description du cosmeticnull
collectionstringBodyDéfini la collectionnull
renderstringBodyDéfini l'affichage 3Dnull
permanentboolBodyDéfini s'il est permanentfalse

🧾 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 obtenable 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/create-cosmetic

Et dans le body mettre par exemple :

{
"name": "batte",
"type": "Sword",
"rarity": "Commun",
"game" : "infecte",
"argumentFr": "Batte de baseball!!!",
"argumentEn": "Baseball bat!!!",
"image": "batte.png",
"lootbox": true
}

📥 Exemple de réponse

Si le cosmétique est bien créé (code 201) :

{
"id": 0,
"name": "batte",
"type": "Sword",
"rarity": "Commun",
"game" : "infecte",
"argumentFr": "Batte de baseball!!!",
"argumentEn": "Baseball bat!!!",
"image": "batte.png",
"lootbox": true,
"price": 0,
"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
409ConflictConflit avec des données existantes
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 409 Conflict :

Ici par exemple, l'erreur 409 signifie que la base de donnée a rencontré une erreur lors de la modification d'un cosmétic. Dans notre cas, le nom batte est déjà utilisé.

{
"message": "could not execute statement [(conn=10039453) Duplicate entry 'batte' for key 'cosmetics_pk_2'] [insert into cosmetics (argument_EN,argument_FR,collection,description,game,image,lootbox,name,permanent,price,rarity,render,type) values (?,?,?,?,?,?,?,?,?,?,?,?,?) returning id]; SQL [insert into cosmetics (argument_EN,argument_FR,collection,description,game,image,lootbox,name,permanent,price,rarity,render,type) values (?,?,?,?,?,?,?,?,?,?,?,?,?) returning id]; constraint [cosmetics_pk_2]",
"code": 409
}