Aller au contenu principal

GET /infecte/get-maps

version 2.0.0

Récupérer les informations des maps.

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

Cette requête ne prend pas de paramètre

🧾 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/get-maps

📥 Exemple de réponse

Si des maps sont trouvées (code 200) :

[
{
"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}"
},
{
"id": 5,
"mapName": "tilted tower",
"winZ": 12,
"winH": 15,
"displayName": "Tilted Tower",
"author": null,
"minPlayer": 10,
"maxPlayer": 25,
"spawnZombie": "{\"x\":-456, \"y\":70, \"z\":1502}",
"spawnHuman": "{\"x\":-400, \"y\":67, \"z\":1550}"
}
]
info

Si aucune map n'est trouvé, l'API retourne un tableau vide.

⛔ 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
404Not foundEntité introuvable
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 les permissions nécessaires pour cette requête.

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