POST /player/create-player

version 2.0.0

Créer un nouveau 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

🧾 Paramètres

Tous les paramètres sont à envoyer dans le corps de la requête :

Nom	Type	Dans	Requis	Description	Valeur par default
pseudo	string	Body	✅	Le pseudo du joueur	❌
token	string	Body	✅	Le token d'identification	❌
gradeId	number	Body	❌	L'identifiant du grade	1
credit	number	Body	❌	Crédits attribués	0
modStatus	bool	Body	❌	Statut de modération	false
staff	bool	Body	❌	Si le joueur fait partie d'un des staffs	false
alert	bool	Body	❌	S'il veut voir les messages réservés aux staffs	false
nickname	string	Body	❌	Surnom	null
firstConnection	string	Body	❌	Date de première connexion	CurrentTimeStamp
totalTimeConnection	double	Body	❌	Temps total de connexion en secondes	0
status	string	Body	❌	Statut du joueur	"Online"
ip	string	Body	❌	Adresse IP	"0.0.0.0"
discordId	string	Body	❌	ID Discord	null
langage	string	Body	❌	Langue préférée	"FR"
streamerPoint	number	Body	❌	Points de streamer	0
tag	string	Body	❌	Tag personnalisé	null
color	string	Body	❌	Couleur associée	null
highclub	boolean	Body	❌	Est membre du Highclub	false
vote	number	Body	❌	Le nombre de points de vote	0

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	❌	L'ID du joueur sélectionné
pseudo	string	❌	Le pseudo du joueur sélectionné
credit	number	❌	Le nombre de crédits du joueur sélectionné
gradeId	number	❌	L'ID du grade du joueur sélectionné
modStatus	bool	❌	Si le joueur est en modérateur
staff	bool	❌	Si le joueur fait partie d'un des staffs
alert	bool	❌	S'il veut voir les messages réservés aux staffs
nickname	string	✅	Le surnom du joueur
status	string	❌	si le joueur est connecté au serveur
discordId	string	✅	Le discord ID s'il est relié
langage	string	❌	La langue du joueur
streamerPoint	number	❌	Le nombre de point de stream du joueur
tag	string	✅	Le grade custom a afficher
color	string	✅	La couleur custom a utiliser
highclub	bool	❌	Si le joueur possède le Highclub
vote	number	❌	Le nombre de points de vote

📤 Exemple de requête

Voici un exemple de requête pour créer un joueur :

http://0.0.0.0/api/player/create-player

Et dans le body à mettre par exemple:

{
    "pseudo": "Zeltaria",
    "token": "azerty123",
    "gradeId": 14,
    "credit": 0,
    "modStatus": false,
    "staff": true,
    "alert": true,
    "nickname": "Zelta",
    "totalTimeConnection": 3600,
    "status": "Online",
    "ip": "127.0.0.1",
    "discordId": "213350119184138241",
    "langage": "FR",
    "streamerPoint": 0,
    "tag": null,
    "color": null,
    "highclub": true,
    "vote" : 0
}

📥 Exemple de réponse

Si tout s’est bien passé (code 201) :

{
    "id": 3,
    "pseudo": "Zeltaria",
    "credit": 0,
    "gradeId": 14,
    "modStatus": false,
    "staff": true,
    "alert": true,
    "nickname": "Zelta",
    "status": "Online",
    "discordId": "213350119184138241",
    "langage": "FR",
    "streamerPoint": 0,
    "tag": null,
    "color": null,
    "highclub": true,
    "vote": 0
}

⛔ Les erreurs

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
409	Conflict	Conflit avec des données existantes
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 409 Conflict :

Ici par exemple, l'erreur 409 signifie que la base de donnée a rencontré une erreur lors de l'ajout du nouvel utilisateur. Dans notre cas, l'username est déjà utilisé par quelqu'un d'autre.

{
    "message": "could not execute statement [(conn=10049555) Duplicate entry 'Zeltaria' for key 'players_pk_2'] [insert into players (alert,color,credit,discord_id,first_connection,grade_id,highclub,ip,language,mod_status,nickname,pseudo,staff,status,streamer_point,tag,token,total_time_connection) values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?) returning id]; SQL [insert into players (alert,color,credit,discord_id,first_connection,grade_id,highclub,ip,language,mod_status,nickname,pseudo,staff,status,streamer_point,tag,token,total_time_connection) values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?) returning id]; constraint [players_pk_2]",
    "code": 409
}