Aller au contenu principal

POST /parkour/create-map

version 2.0.0

Créer une nouvelle 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
  • Axel

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
namestringBodyLe nom de la map
enableboolBodySi la map est activefalse
spawnLocationstringbodyLe point d'apparition de la mapnull
difficultystringbodyLa difficulté de la mapnull

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID de la map
namestringLe nom de la map
enableboolSi la map est active
spawnLocationstringLe point d'apparition de la map
difficultystringLa difficulté de la map

📤 Exemple de requête

http://0.0.0.0/api/parkour/create-map

Et dans le body mettre par exemple :

{
"name": "Test 1"
}

📥 Exemple de réponse

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

{
"id": 1,
"name": "Test 1",
"enable": false,
"spawnLocation": "{x:100, y:65, z:1296, world:world, pitch:50, yaw:50}",
"difficulty": "easy"
}

⛔ 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
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 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas accès à cette requête.

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