Aller au contenu principal

POST /minigame/setup-player

version 2.0.0

Setup 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 :

  • Corail
  • Zelta

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
playerIdnumberBodyL'ID du joueur sélectionné
dailyPrivatenumberBodyLe nombre de ticket privé journalier0
dailyOptionnumberBodyLe nombre de ticket option journalier0
ticketPrivatenumberBodyLe nombre de ticket d'host privé0
ticketOptionnumberBodyLe nombre de ticket d'option0
partyRequestboolBodySi le joueur accepte de recevoir des invitations de partytrue

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'ID du joueur sélectionné
dailyPrivatenumberLe nombre de ticket privé journalier
dailyOptionnumberLe nombre de ticket option journalier
ticketPrivatenumberLe nombre de ticket d'host privé
ticketOptionnumberLe nombre de ticket d'option
partyRequestboolSi le joueur accepte de recevoir des invitations de party

📤 Exemple de requête

Voici un exemple de requête pour créer les options d'un joueur :

http://0.0.0.0/api/minigame/setup-player

Et dans le body à mettre par exemple:

{
"playerId": 2
}

📥 Exemple de réponse

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

{
"playerId": 2,
"gradeId": 1,
"ticketPrivate": 0,
"ticketOption": 0,
"partyRequest": true
}

⛔ 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 404 Not found :

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

{
"message": "Player not found",
"code": 404
}