GET /code/get-code

version 2.0.0

Récupère 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

Un seul de ces paramètres est requis (dans l'URL) pour identifier le code :

Nom	Type	Dans	Requis	Description	Valeur par default
id	string	URL	⚠️	L'id du code	❌
code	string	URL	⚠️	Le nom du code	❌

🧾 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	number	❌	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 pour récupérer un code via son id :

http://0.0.0.0/api/code/get-code?id=2

📥 Exemple de réponse

Si le code est trouvé, la réponse (code 200) sera :

{
    "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
404	Not found	Entité introuvable
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 404 Not found :

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

{
    "message": "No value present",
    "code": 404
}