Aller au contenu principal

GET /bot/get-today-birthdays

version 2.0.0

Récupère tous les anniversaires présent pour le jour actuel.

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

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
discordIdstringL'identifiant Discord de la personne
birthdaystringLa date d’anniversaire (format YYYY-MM-DD)

📤 Exemple de requête

Voici un exemple pour récupérer les anniversaires du jour :

http://0.0.0.0/api/bot/get-today-birthdays

📥 Exemple de réponse

Si des anniversaires sont trouvés (date du 1er août pour l'exemple), la réponse (code 200) sera :

[
{
"discordId": "213350119184138241",
"anniv": "2001-08-01"
},
{
"discordId": "843454193276289056",
"anniv": "2005-08-01"
}
]
info

Si aucun anniversaire n'est trouvé pour ce jour, 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
404Not foundEntité introuvable
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 accès à cette requête.

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