[Proposition] Mise en place de l'api NotABot

[SirMishaa]

Cette issue n'est pas une RFC, néanmoins je vais essayer de décrire de la manière la plus succincte ce que je vois pour l'api.

Pour la structure de l'api, je pense à quelque chose du genre avec l'ensemble des actions possibles :

• https://notabot.fr/api/v1/guild/323076998576603137 : Permet de récupérer les informations d'une guild (serveur)

J'imagine aussi la possibilité de filtrer certains champs, comme avoir un paramètre GET afin de récupérer une seule information par exemple :

https://notabot.fr/api/v1/guild/323076998576603137?fields=memberCount,description

Certaines informations ne sont accessibles qu'a des personnes ayant des permissions particulières. Je propose donc cette approche pour l'authentification :

1. Connexion OAuth 2 avec Discord (afin de récupérer un token d'autorisation et l'identifiant de l'utilisateur)
2. L'utilisateur effectue une requête pour modifier un rôle sur le serveur par exemple, il passe en paramètre le token d'autorisation
3. L'api va vérifier au prêt du serveur si l'utilisateur est bien sur le serveur, et s'il possède les droits nécessaires pour effectuer l'action
4. Si c'est le cas, le serveur modifie bien le rôle et renvoie une réponse 200. Le cas échéant, il renvoie une 401 / 403

Il serait aussi bien de pouvoir de désactiver l'accès au serveur depuis l'api, pour x / y raisons. Ou au moins avoir un contrôle avancé concernant les permissions.

Concernant les informations globales du bot, je pense aux possibilités suivantes :

• https://notabot.fr/api/v1/guilds : Retourne les serveurs sur lequel est le bot
• https://notabot.fr/api/v1/guild/323076998576603137/stats : Retourne les statistiques d'un serveur
• https://notabot.fr/api/v1/guild/323076998576603137/channels?type=TextChannel : Récupère les canaux textes d'un serveur
• https://notabot.fr/api/v1/about : Retourne les informations du bot, comme le fait s'il est en ligne, sa présence, ect...

Je mets en évidence le fait que c'est un exemple, l'idée est (au début) surtout d'avoir une API qui permet de récupérer des informations basiques.

Moi, je voudrais par exemple communiquer avec l'api pour faire des statistiques.
C'est impossible de proposer une API complète dés le début, donc il faut y aller step par step.