GET /website/get-reward

version 2.1.0

Récupère une récompense.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

Modification

Depuis la 2.1.0 il s'agit d'une nouvelle requête
Si vous cherchez l'ancienne, elle a été nommée /get-reward-log !

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

Un seul paramètre est requis dans l'URL :

Nom	Type	Dans	Requis	Description
`id`	string	URL	✅	L'id de la récompense

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

Nom	Type	Nullable	Description
`id`	number	❌	L'id du log de la récompense
`xpNeeded`	number	❌	Le nombre d'xp nécéssaire pour avoir cette récompense
`type`	string	❌	Le type de la récompense
`value`	string	❌	La valeur de la récompense

Voici un exemple pour récupérer la récompense :

http://0.0.0.0/api/website/get-reward?id=1

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

{
    "id": 1,
    "xpNeeded": 200,
    "type": "badge",
    "value": "32"
}

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 la récompense n'a pas été trouvé dans la base de données.

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