ametistos
DE

API-Dokumentation für Minecraft-Server-Hosting

Ein Alpha-Überblick über die Ametistos-API, die von der Web-Systemsteuerung für Authentifizierung, Server, Spieler, Dateien, Zugriff, Benachrichtigungen und Kontodaten genutzt wird.

Status der Ametistos-API während der Alpha-Phase

Die Anwendung kommuniziert mit der versionierten Ametistos-API unter https://api.ametistos.com/api/v1. Der Vertrag entwickelt sich während der Alpha-Phase noch weiter, daher sollten Integrationen mit Validierungsfehlern, nicht verfügbaren Funktionen und Antwortänderungen umgehen können. Zeige Zugriffstoken nicht in Browser-Logs oder öffentlichen Repositories an.

Authentifizierungs- und Kontoendpunkte

  • POST /auth/email/resend— E-Mail-Bestätigungscode erneut senden.
  • POST /auth/email/confirm— Konto mit erhaltenem Code bestätigen.
  • POST /auth/password/forgot— Passwort-Reset-Code anfordern.
  • POST /auth/password/reset— Code prüfen und neues Passwort setzen.
  • GET /auth/google— Google-Authentifizierung starten.
  • PATCH /users/password— Passwort des authentifizierten Nutzers aktualisieren.

Minecraft-Server- und Spieler-Operationen

Authentifizierte Server-Routen bieten Erstellung und Konfiguration, Laufzeitstatus, Konsolenbefehle, Dateien, Software, Erweiterungen und Spielerinformationen. Spielerstatistiken sind unter /servers/players/stats/:serverIdverfügbar. Konsolenähnliche Moderationsbefehle werden über /servers/command/:serverIdmit einer JSON-Befehlsnutzlast gesendet.

Benachrichtigungen, Zugriff und Promocodes

Die Systemsteuerung liest Kontobenachrichtigungen von /notifications/me. Zugriffsrouten listen Mitwirkende auf und ändern deren begrenzte Berechtigungen. Promocode-Routen aktivieren einen Code und geben zuvor genutzte Aktionen und Vorteile des authentifizierten Nutzers zurück.

Anforderungen an die API-Integration

  • Sende das aktuelle Bearer-Token nur an die konfigurierte Ametistos-API-Origin.
  • Prüfe auf ein gültiges Token, bevor du geschützte Konto- oder Serverrouten lädst.
  • Behandle 401-, 403-, 404-, Validierungs- und Kompatibilitätsantworten explizit.
  • Invalidiere zwischengespeicherte Serverdaten nach Mutationen wie Uploads, Befehlen oder Resets.
  • Rufe Container-Statistiken nur ab, während der Minecraft-Serverstatus online ist.