Aller au contenu principal

POST /infecte/create-achievement

version 2.0.0

Ajouter un achievement.

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
typestringbodyLe type d'achievement
namestringbodyLe nom de l'achievement
descriptionstringbodyLa description de l'achievementnull
rewardstringbodyLes récompenses de l'achievementnull

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de l'achievement
typestringLe type d'achievement
namestringLe nom de l'achievement
descriptionstringLa description de l'achievement
rewardstringLes récompenses de l'achievement

📤 Exemple de requête

http://0.0.0.0/api/infecte/create-achievement

Et dans le body mettre par exemple :

{
"type": "kills",
"name": "Tueur en série",
"description": "Tuer 100 humains",
"reward": "{\"xp\":500, \"cosmetic\":\"red_hat\"}"
}

📥 Exemple de réponse

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

{
"id": 2,
"type": "kills",
"name": "Tueur en série",
"description": "Tuer 100 humains",
"reward": "{\"xp\":500, \"cosmetic\":\"red_hat\"}"
}

⛔ 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 401 Unauthorized :

Ici par exemple, l'erreur 401 signifie que vous n'avez pas la permission nécessaire pour cette requête.

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