POST /code/create-code

version 2.0.0

Créer un code.

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
• Site

🧾 Paramètres

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

Nom	Type	Dans	Requis	Description	Valeur par default
code	string	Body	✅	Le nom du code	❌
credit	number	Body	❌	Le nombre de crédit qu'il donne	0
badgeId	number	Body	❌	Le badge que donne ce code	null
cosmeticId	number	Body	❌	Le cosmétique que donne ce code	null
usageLimit	number	Body	❌	Le nombre d'usage du code	-1
startDate	string	Body	❌	La date de début du code	currentTimeStamp
expirationDate	string	Body	❌	La date de fin du code	❌
requiredPower	number	Body	❌	Le power minimum requis pour utiliser le code	0

info

Si vous voulez un usage ilimité, mettez usageLimit a -1.

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	❌	L'identifiant du code créé
code	string	❌	Le nom du code
credit	number	❌	Le nombre de crédit qu'il donne
badgeId	number	✅	Le badge que donne ce code
cosmeticId	number	✅	Le cosmétique que donne ce code
usageLimit	number	❌	Le nombre d'usage du code
startDate	string	❌	La date de début du code
expirationDate	string	✅	La date de fin du code
requiredPower	number	❌	Le power minimum requis pour utiliser le code

📤 Exemple de requête

Voici un exemple d’appel à cette route :

http://0.0.0.0/api/code/create-code

Et dans le body mettre par exemple :

{
    "code": "test",
    "expirationDate": "2025-04-17"
}

📥 Exemple de réponse

Si le code est bien créé (code 201) :

{
    "id": 2,
    "code": "test",
    "credit": 0,
    "badgeId": null,
    "cosmeticId": null,
    "usageLimit": -1,
    "startDate": "2025-04-05",
    "expirationDate": "2025-04-17",
    "requiredPower": 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
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 du nouvel code. Dans notre cas, le code test est déjà créé.

{
    "message": "could not execute statement [(conn=10025523) Duplicate entry 'test' for key 'codes_pk_2'] [insert into codes (badge_id,code,cosmetic_id,credit,expiration_date,required_power,usage_limit) values (?,?,?,?,?,?,?) returning id]; SQL [insert into codes (badge_id,code,cosmetic_id,credit,expiration_date,required_power,usage_limit) values (?,?,?,?,?,?,?) returning id]; constraint [codes_pk_2]",
    "code": 409
}