POST /code/add-used-code

version 2.0.0

Ajouter l'utilisation d'un code à 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

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

Nom	Type	Dans	Requis	Description	Valeur par default
playerId	number	Body	✅	L'id du joueur	❌
codeId	number	Body	✅	L'id du code	❌

🧾 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
codeId	number	❌	L'id du code

📤 Exemple de requête

Voici un exemple d’appel à cette route :

http://0.0.0.0/api/code/add-used-code

Et dans le body mettre par exemple :

{
    "code" : 1,
    "badgeId" : 2
}

📥 Exemple de réponse

Si l'utilisation du code est bien créée (code 201) :

{
    "code": 1,
    "badgeId": 2
}

⛔ 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 de la nouvelle utilisation du code. Dans notre cas, le code 2 a déjà été utilisé par le joueur 1.

{
    "message": "could not execute statement [(conn=9599154) Duplicate entry '1-2' for key 'PRIMARY'] [insert into used_codes (code_id,player_id) values (?,?)]; SQL [insert into used_codes (code_id,player_id) values (?,?)]; constraint [PRIMARY]",
    "code": 409
}