Aller au contenu principal

POST /infecte/add-map

version 2.0.0

Ajouter une map.

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
mapNamestringbodyNom de la map
winZnumberbodyLe nombre de win en tant que zombie0
winHnumberbodyLe nombre de win en tant qu'humain0
displayNamestringbodyLe nom d'affichage de la map
authorstringbodyL'auteur de la mapnull
minPlayernumberbodyLe nombre minimum de joueurs2
maxPlayernumberbodyLe nombre maximum de joueurs24
spawnZombiestringbodyLes coordonnées du spawn Zombie
spawnHumanstringbodyLes coordonnées du spawn Humain

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id de la map
mapNamestringNom de la map
winZnumberLe nombre de win en tant que zombie
winHnumberLe nombre de win en tant qu'humain
displayNamestringLe nom d'affichage de la map
authorstringL'auteur de la map
minPlayernumberLe nombre minimum de joueurs
maxPlayernumberLe nombre maximum de joueurs
spawnZombiestringLes coordonnées du spawn Zombie
spawnHumanstringLes coordonnées du spawn Humain

📤 Exemple de requête

http://0.0.0.0/api/infecte/add-map

Et dans le body mettre par exemple :

{
"mapName": "lonely town",
"displayName": "Lonely Town",
"spawnZombie": "{\"x\":120, \"y\":64, \"z\":-516}",
"spawnHuman": "{\"x\":110, \"y\":65, \"z\":-681}"
}

📥 Exemple de réponse

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

{
"id": 2,
"mapName": "lonely town",
"winZ": 0,
"winH": 0,
"displayName": "Lonely Town",
"author": "NokoShizen",
"minPlayer": 2,
"maxPlayer": 15,
"spawnZombie": "{\"x\":120, \"y\":64, \"z\":-516}",
"spawnHuman": "{\"x\":110, \"y\":65, \"z\":-681}"
}

⛔ 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
}