PATCH /freebuild/update-player
Modifie une ou plusieurs informations 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
🧾 Paramètres
Tous les paramètres sont à envoyer dans le corps de la requête :
| Nom | Type | Dans | Requis | Description |
|---|---|---|---|---|
playerId | number | body | ✅ | L'id du joueur |
additionalWorld | number | body | ❌ | Le nombre de monde en plus |
maxBorder | number | body | ❌ | La distance de la bordure |
additionalBackup | number | body | ❌ | Le nombre de backup |
purchasedPack | number | body | ❌ | Le nombre de pack acheter |
worldName | string | body | ❌ | Le nom du monde |
playtime | number | body | ❌ | Le temps de jeu du joueur |
🧾 Réponse
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 |
additionalWorld | number | ❌ | Le nombre de monde en plus |
maxBorder | number | ❌ | La distance de la bordure |
additionalBackup | number | ❌ | Le nombre de backup |
purchasedPack | number | ❌ | Le nombre de pack acheter |
worldName | string | ❌ | Le nom du monde |
playtime | number | ❌ | Le temps de jeu du joueur |
📤 Exemple de requête
http://0.0.0.0/api/freebuild/update-player
{
"playerId": 42,
"additionalWorld": 1,
"purchasedPack": 1
}
📥 Exemple de réponse
Voici un exemple de réponse si la modification a été effectuée avec succès (code 200) :
{
"playerId": 42,
"additionalWorld": 1,
"maxBorder": 1000,
"additionalBackup": 0,
"purchasedPack": 1,
"worldName": "MonSuperMonde",
"playtime": 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 |
| 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
}