POST /minigame/setup-player
Setup les options d'un joueur.
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 |
|---|---|---|---|---|---|
playerId | number | Body | ✅ | L'ID du joueur sélectionné | ❌ |
dailyPrivate | number | Body | ❌ | Le nombre de ticket privé journalier | 0 |
dailyOption | number | Body | ❌ | Le nombre de ticket option journalier | 0 |
ticketPrivate | number | Body | ❌ | Le nombre de ticket d'host privé | 0 |
ticketOption | number | Body | ❌ | Le nombre de ticket d'option | 0 |
partyRequest | bool | Body | ❌ | Si le joueur accepte de recevoir des invitations de party | true |
🧾 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 sélectionné |
dailyPrivate | number | ❌ | Le nombre de ticket privé journalier |
dailyOption | number | ❌ | Le nombre de ticket option journalier |
ticketPrivate | number | ❌ | Le nombre de ticket d'host privé |
ticketOption | number | ❌ | Le nombre de ticket d'option |
partyRequest | bool | ❌ | Si 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 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 |
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 playerId n'a pas été trouvé dans la base de données.
{
"message": "Player not found",
"code": 404
}