OpenBotsDocs
05 API

API

Les API d'OpenBots aujourd'hui : ce qui est utilisable, avec quels droits, et des exemples.

Les exemples de cette page sont génériques. Connecte-toi pour les voir avec les salons et rôles de ton serveur.

🔌 API

[!NOTE] Il n'existe pas encore d'API publique OpenBots (pas de clé d'API, pas de garantie de stabilité). Cette page décrit ce qui existe aujourd'hui ; les exemples ci-dessous utilisent ton serveur quand tu es connecté.


Les deux API existantes

APIÀ quoi elle sertQui peut l'appeler
API interne des botsLe panel parle à chaque bot (salons, rôles, envoi de messages…).Uniquement l'infrastructure OpenBots : elle n'est pas authentifiée et n'est pas joignable depuis Internet.
API v2Sert la nouvelle application web d'OpenBots (en cours de construction, pas encore en ligne).Un compte connecté au panel, pour ses serveurs. Lecture possible depuis un navigateur connecté ; les modifications sont réservées à l'application OpenBots elle-même.

L'API v2 utilise ta session du panel (connexion Discord) : elle voit exactement ce que tu vois dans le dashboard, avec les mêmes droits. Elle peut encore changer sans préavis.


🧪 Exemples (API v2, lecture)

Quand l'API v2 sera en ligne, il suffira d'ouvrir ces adresses dans un navigateur connecté au panel.

Ton compte et ton forfait :

GET /api/v2/me

Les serveurs que tu peux ouvrir (ceux que tu gères, et ceux en Mode Communauté dont tu es membre) :

GET /api/v2/guilds

Les modules de Mon Serveur (activés ou non, et ceux que ton forfait ne comprend pas) :

GET /api/v2/guilds/123456789012345678/dashboard

Les réglages d'un module, par exemple Bienvenue :

GET /api/v2/guilds/123456789012345678/modules/welcome

Les changements programmés de l'agenda et l'état du Mode Communauté :

GET /api/v2/guilds/123456789012345678/agenda
GET /api/v2/guilds/123456789012345678/community

La grille des forfaits et la cagnotte communautaire (sans connexion) :

GET /api/v2/pricing
GET /api/v2/pool

Réponses possibles : 401 si tu n'es pas connecté, 403 si ce serveur n'est pas le tien.


🚧 Ce qui est prévu

Une vraie API pour les développeurs (clés d'accès, documentation des réponses, quotas) viendra quand la nouvelle application sera en service. Cette page sera alors complétée.

On this page