Aller au contenu principal

GET /player/get-cosmetics

version 2.0.0

Récupère les cosmétiques d'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

Un seul de ces paramètres est requis (dans l'URL) pour identifier le joueur :

NomTypeDansRequisDescriptionValeur par default
playerIdnumberBodyL'ID du joueur

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'ID du joueur
cosmeticIdnumberL'ID du cosmétique
activeboolSi il est actif

📤 Exemple de requête

Si je souhaite chercher les informations du joueur d'id 2 voici ma requête :

http://0.0.0.0/api/player/get-cosmetics?playerId=1

📥 Exemple de réponse

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

Si tout va bien et que le joueur est trouvé (code 200) :

[
{
"playerId": 1,
"cosmeticId": 1,
"active": false
}
]
info

Si aucun cosmétic 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 accès à cette requête.

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