HYAUTHDashboard

Erste Schritte

Integriere HyAuth in deine Anwendung in wenigen einfachen Schritten.

1

Im Dashboard anmelden

Gehe zum Dashboard und melde dich mit deinem Hytale-Konto an, um deine API-Schlüssel zu verwalten.

2

API-Schlüssel erstellen

Erstelle einen neuen API-Schlüssel im Dashboard. Der Schlüsselname wird Benutzern während der Authentifizierung angezeigt.

3

Auth-Session erstellen

Sende eine POST-Anfrage, um eine Authentifizierungssession zu erstellen. Du erhältst eine Session-ID und eine Login-URL zur Weiterleitung der Benutzer.

4

Ergebnis abrufen

Frage den Session-Endpoint ab, um zu prüfen, ob der Benutzer das Login abgeschlossen hat. Nach Abschluss erhältst du die angeforderten Profildaten.

API-Referenz

Vollständige Referenz der HyAuth-Authentifizierungs-API.

POST/api/auth/create

Erstellt eine neue Authentifizierungssession und gibt eine Login-URL für den Benutzer zurück.

Header

Authorization: Bearer hy_your_api_key
Content-Type: application/json

Anfragekörper

{
  "scopes": {
    "gameProfiles": true,
    "email": true
  },
  "redirectUrl": "https://yourapp.com/callback"
}

Antwort

{
  "success": true,
  "sessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "loginUrl": "https://www.hyauth.com/login?session=a1b2c3d4...",
  "expiresIn": 599
}
GET/api/auth/{sessionId}

Ruft den aktuellen Status und das Ergebnis einer Authentifizierungssession ab.

Header

Authorization: Bearer hy_your_api_key

Antwort — Ausstehend

{
  "success": true,
  "status": "pending"
}

Antwort — Abgeschlossen

{
  "success": true,
  "status": "completed",
  "kratosId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "email": "player@example.com",
  "gameProfiles": [
    {
      "username": "Player123",
      "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "entitlements": ["game.base", "game.deluxe"],
      "skin": "{...}",
      "createdAt": "2025-01-15T12:00:00.000000Z"
    }
  ]
}

Antwort — Fehlgeschlagen

{
  "success": true,
  "status": "failed"
}

Scopes

Scopes definieren, auf welche Daten deine Anwendung vom Hytale-Konto des Benutzers zugreifen kann.

gameProfiles

Zugriff auf die Spielprofile des Benutzers, einschließlich Benutzername, UUID und Skin-URL.

emailPrivileged

Zugriff auf die E-Mail-Adresse des Benutzers. Dies ist ein privilegierter Scope und erfordert eine Genehmigung.

Fehlercodes

Die API verwendet Standard-HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.

400

Bad Request — Fehlende oder ungültige Parameter.

401

Unauthorized — Ungültiger oder fehlender API-Schlüssel.

403

Forbidden — API-Schlüssel hat keinen Zugriff auf angeforderte Scopes.

404

Not Found — Session-ID existiert nicht.

502

Bad Gateway — Upstream-Hytale-Dienst nicht verfügbar.

Dokumentation - HyAuth