HYAUTHDashboard

Primeros Pasos

Integra HyAuth en tu aplicación en unos sencillos pasos.

1

Inicia sesión en el Panel

Ve al Panel de Control e inicia sesión con tu cuenta de Hytale para gestionar tus claves API.

2

Crea una Clave API

Crea una nueva clave API desde el panel. El nombre de la clave se mostrará a los usuarios durante la autenticación.

3

Crea una Sesión de Auth

Haz una petición POST para crear una sesión de autenticación. Recibirás un ID de sesión y una URL de inicio de sesión para redirigir a los usuarios.

4

Obtén el Resultado

Consulta el endpoint de sesión para verificar si el usuario ha completado el inicio de sesión. Una vez completado, recibirás los datos de perfil solicitados.

Referencia de la API

Referencia completa de la API de autenticación de HyAuth.

POST/api/auth/create

Crea una nueva sesión de autenticación y devuelve una URL de inicio de sesión para el usuario.

Cabeceras

Authorization: Bearer hy_your_api_key
Content-Type: application/json

Cuerpo de la Petición

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

Respuesta

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

Recupera el estado actual y el resultado de una sesión de autenticación.

Cabeceras

Authorization: Bearer hy_your_api_key

Respuesta — Pendiente

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

Respuesta — Completado

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

Respuesta — Fallido

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

Scopes

Los scopes definen a qué datos puede acceder tu aplicación desde la cuenta Hytale del usuario.

gameProfiles

Accede a los perfiles de juego del usuario incluyendo nombre de usuario, UUID y URL del skin.

emailPrivileged

Accede a la dirección de correo electrónico del usuario. Este es un scope privilegiado que requiere aprobación.

Códigos de Error

La API utiliza códigos de estado HTTP estándar para indicar el éxito o fracaso de una petición.

400

Bad Request — Parámetros ausentes o no válidos.

401

Unauthorized — Clave API no válida o ausente.

403

Forbidden — La clave API no tiene acceso a los scopes solicitados.

404

Not Found — El ID de sesión no existe.

502

Bad Gateway — Servicio Hytale upstream no disponible.

Documentación - HyAuth