Aller au contenu principal

POST /freebuild/create-player

version 2.0.0

Créer un joueur pour le freebuild.

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

Les champs suivants sont attendus dans le corps de la requête :

NomTypeDansRequisDescriptionValeur par default
playerIdnumberbodyL'id du joueur
additionalWorldnumberbodyLe nombre de monde en plus
maxBordernumberbodyLa distance de la bordure
additionalBackupnumberbodyLe nombre de backup
purchasedPacknumberbodyLe nombre de pack acheter
worldNamestringbodyLe nom du monde
playtimenumberbodyLe temps de jeu du joueur0

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'id du joueur
additionalWorldnumberLe nombre de monde en plus
maxBordernumberLa distance de la bordure
additionalBackupnumberLe nombre de backup
purchasedPacknumberLe nombre de pack acheter
worldNamestringLe nom du monde
playtimenumberLe temps de jeu du joueur

📤 Exemple de requête

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

Et dans le body mettre par exemple :

{
"playerId": 42,
"additionalWorld": 0,
"maxBorder": 1000,
"additionalBackup": 0,
"purchasedPack": 0,
"worldName": "MonSuperMonde"
}

📥 Exemple de réponse

Si le joueur a bien été créé (code 201) :

{
"playerId": 42,
"additionalWorld": 0,
"maxBorder": 1000,
"additionalBackup": 0,
"purchasedPack": 0,
"worldName": "MonSuperMonde"
}

⛔ 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 vous n'avez pas accès à cette requête.

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