HYAUTHDashboard

Per Iniziare

Integra HyAuth nella tua applicazione in pochi semplici passaggi.

1

Accedi alla Dashboard

Vai alla Dashboard e accedi con il tuo account Hytale per gestire le tue chiavi API.

2

Crea una Chiave API

Crea una nuova chiave API dalla dashboard. Il nome della chiave verrà mostrato agli utenti durante l'autenticazione.

3

Crea una Sessione di Auth

Fai una richiesta POST per creare una sessione di autenticazione. Riceverai un ID sessione e un URL di login per reindirizzare gli utenti.

4

Ottieni il Risultato

Interroga l'endpoint della sessione per verificare se l'utente ha completato il login. Una volta completato, riceverai i dati del profilo richiesti.

Riferimento API

Riferimento completo dell'API di autenticazione HyAuth.

POST/api/auth/create

Crea una nuova sessione di autenticazione e restituisce un URL di login per l'utente.

Intestazioni

Authorization: Bearer hy_your_api_key
Content-Type: application/json

Corpo della Richiesta

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

Risposta

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

Recupera lo stato attuale e il risultato di una sessione di autenticazione.

Intestazioni

Authorization: Bearer hy_your_api_key

Risposta — In attesa

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

Risposta — Completato

{
  "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"
    }
  ]
}

Risposta — Fallito

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

Scope

Gli scope definiscono a quali dati la tua applicazione può accedere dall'account Hytale dell'utente.

gameProfiles

Accedi ai profili di gioco dell'utente inclusi username, UUID e URL skin.

emailPrivileged

Accedi all'indirizzo email dell'utente. Questo è uno scope privilegiato che richiede approvazione.

Codici di Errore

L'API utilizza codici di stato HTTP standard per indicare il successo o il fallimento di una richiesta.

400

Bad Request — Parametri mancanti o non validi.

401

Unauthorized — Chiave API non valida o mancante.

403

Forbidden — La chiave API non ha accesso agli scope richiesti.

404

Not Found — L'ID sessione non esiste.

502

Bad Gateway — Servizio Hytale upstream non disponibile.

Documentazione - HyAuth