GET /player/get-option

version 2.0.0

Récupère les options 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 :

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

Nom	Type	Dans	Requis	Description	Valeur par default
`playerId`	number	URL	✅	L'identifiant unique du joueur	❌

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

Nom	Type	Nullable	Description
`playerId`	number	❌	L'ID du joueur sélectionné
`privateMessage`	string	❌	De qui veut-il recevoir des message privé
`friendDemand`	bool	❌	Reçois t-il les demandes d'amie
`youtubeChannel`	string	✅	Le lien vers la chaine YouTube du joueur
`twitchChannel`	string	✅	Le lien vers la chaine Twitch du joueur

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

http://0.0.0.0/api/player/get-option?playerId=2

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

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

{
    "playerId": 2,
    "privateMessage": "TOUS",
    "friendDemand": true,
    "youtubeChannel": null,
    "twitchChannel": null
}

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur 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

Nom	Type	Description
`code`	number	Le code d'erreur que retourne la requête
`message`	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

Ici par exemple, l'erreur 404 signifie que le joueur n'a pas été trouvé dans la base de données.

{
    "message": "No value present",
    "code": 404
}