Aller au contenu principal

POST /minigame/create-server

version 2.0.0

Créer un nouveau server minigame.

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
idstringBodyL'id du server
gamestringBodyLe nom du jeu du server
ownerIdnumberBodyL'id du joueur qui a créer le host
whiteliststringBodyLes joueurs qui sont whitelist (null si public)null
statusstringBodyLe status du server
Power

Le champ power doit forcément être plus grand que 0.

🧾 Réponse

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

NomTypeNullableDescription
idstringL'id du server
gamestringLe nom du jeu du server
ownerIdnumberL'id du joueur qui a créer le host
whiteliststringLes joueurs qui sont whitelist (null si public)
statusstringLe status du serveur

📤 Exemple de requête

http://0.0.0.0/api/minigame/create-server

Et dans le body mettre par exemple :

{
"id": "GolemRush-5212",
"game": "GolemRush",
"ownerId": 43,
"status": "public"
}

📥 Exemple de réponse

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

{
"id": "GolemRush-5212",
"game": "GolemRush",
"ownerId": 43,
"whitelist": null,
"status": "public"
}

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

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

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