Aller au contenu principal

GET /website/get-rewards

version 2.1.0

Récupère toutes les récompenses.

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

Aucun paramètre n'est requis pour cette requête.

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id du log de la récompense
xpNeedednumberLe nombre d'xp nécéssaire pour avoir cette récompense
typestringLe type de la récompense
valuestringLa valeur de la récompense

📤 Exemple de requête

Voici un exemple pour récupérer toutes les récompenses :

http://0.0.0.0/api/website/get-rewards

📥 Exemple de réponse

Si des récompenses sont trouvées, la réponse (code 200) sera :

[
{
"id": 1,
"xpNeeded": 200,
"type": "badge",
"value": "32"
},
{
"id": 2,
"xpNeeded": 400,
"type": "crédits",
"value": "5"
}
]
info

Si aucune récompense n'est trouvée, l'API retourne un tableau vide.

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
500Internal Server ErrorErreur 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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

{
"message": "Access Denied",
"code": 403
}