Aller au contenu principal

POST /badge/create-badge

version 2.0.0

Créer un nouveau badge.

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

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
namestringBodyNom du badge
descriptionstringBodyDescription du badge
raritystringBodyRareté du badge (ex. commun, rare, etc.)
texturestringBodyURL de l’image du badge
obtainableboolBodyBadge obtenable hors event ?

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID du grade
namestringLe nom du grade à créer
descriptionstringDescription du badge
raritystringRareté du badge (ex. commun, rare, etc.)
texturestringURL de l’image du badge
obtainableboolBadge obtenable hors event ?

📤 Exemple de requête

http://0.0.0.0/api/badge/create-badge

Et dans le body mettre par exemple :

{
"name": "test",
"description": "Un badge pour tester.",
"rarity": "Rare",
"texture": "text.png",
"obtainable": false
}

📥 Exemple de réponse

Si le badge est bien créé (code 201) :

{
"id" : 8,
"name": "test",
"description": "Un badge pour tester.",
"rarity": "Rare",
"texture": "text.png",
"obtainable": 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 l'ajout du nouveau badge. Dans notre cas, le nom Test est déjà utilisé.

{
"message": "could not execute statement [(conn=9858973) Duplicate entry 'Test' for key 'badges_pk_2'] [insert into badges (description,name,obtainable,rarity,texture) values (?,?,?,?,?) returning id]; SQL [insert into badges (description,name,obtainable,rarity,texture) values (?,?,?,?,?) returning id]; constraint [badges_pk_2]",
"code": 409
}