Aller au contenu principal

GET /player/get-nick-already-used

version 2.0.0

Permet de vérifier si un nickname est déjà utilisé par un joueur.

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 :

NomTypeDansRequisDescriptionValeur par default
nickstringURLLe nickname a vérifier

🧾 Réponse

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

NomTypeNullableDescription
existboolSi le nickname est déjà utiliser
nickstringLe nickname a vérifier

📤 Exemple de requête

Si je souhaite savoir si le nickname Zelta est déjà utilisé, je ferai la requête suivante :

http://0.0.0.0/api/player/get-nick-already-used?nick=Zelta

📥 Exemple de réponse

Voici le retour de l'API en fonction du résultat :

Si tout va bien (code 200) :

{
"exist": true,
"nick": "Zelta"
}

⛔ 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 le joueur n'a pas les droits nécessaires pour cette requête.

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