Aller au contenu principal

GET /website/get-maintenance

version 2.0.0

Récupère le status de la maintenance du site.

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

Le paramètre suivant est requis dans l'URL pour identifier le joueur dont on souhaite récupérer le compte :

NomTypeDansRequisDescription
idnumberURLL’id du site (1)

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID du site
statusnumberLe status du site

📤 Exemple de requête

Voici un exemple pour récupérer le compte d'un joueur :

http://0.0.0.0/api/website/get-maintenance?id=1

📥 Exemple de réponse

Si le compte est trouvé, la réponse (code 200) sera :

{
"id": 1,
"status": 1
}

⛔ 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 accès à cette requête.

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