Documentation · API & ingestion
API & ingestion
Concepts communs à tous les jeux : authentification, deux flux d'entrée, convention d'événements et rétrocompatibilité.
Authentification
Toutes les routes d'ingestion exigent la clé secrète du serveur dans l'entête X-Server-Key. À copier depuis l'onglet Paramètres du serveur dans le dashboard.
Le jeu (game), le tenant et l'identifiant serveur sont déterminés automatiquement côté API à partir de cette clé : le plugin n'a pas besoin de les envoyer dans le corps JSON.
Deux flux d'entrée
1 · Événements POST /api/ingest (& batch)
Comportements joueur pour rapports et historique : join, mort, chat, économie, etc. Alimentent game_events et les graphiques métier.
2 · Signaux POST /api/ingest/signal
Démarrage / arrêt du processus et échantillons de performance (TPS, mémoire, joueurs connectés). Stockés dans server_signals — voir Signaux Minecraft Java.
Événements globaux vs spécifiques
Nous encourageons les mêmes noms d'événements lorsque la situation métier existe partout, en SCREAMING_SNAKE_CASE.
- Transversal :
PLAYER_JOIN,PLAYER_QUIT,ECONOMY_TRANSACTION. - Spécifique au jeu :
BLOCK_BREAK,BLOCK_PLACEpour Minecraft Java.
Catalogue détaillé : Événements Minecraft Java. Les widgets Studio acceptent tout eventType, y compris hors catalogue.
Rétrocompatibilité API
Les types obsolètes comme PERFORMANCE, SERVER_START ou SERVER_STOP envoyés sur POST /api/ingest sont transformés automatiquement en signaux équivalents.