Aller au contenu principal

GET /minigame/get-servers

version 2.0.0

Récupérer les informations de tous les servers 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
  • Axel

🧾 Paramètres

Aucun paramètre n'est requis pour cette requête.

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

📥 Exemple de réponse

Si le server est trouvé (code 200) :

[
{
"id": "GolemRush-5212",
"game": "GolemRush",
"ownerId": 43,
"whitelist": null,
"status": "public"
},
{
"id": "Osmose-120",
"game": "Osmose",
"ownerId": 44,
"whitelist": "Tahyme, corail44",
"status": "private"
}
]
info

Si aucun servers 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 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

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