HYAUTHTableau de bord

Premiers Pas

Intégrez HyAuth dans votre application en quelques étapes simples.

1

Connectez-vous au Tableau de Bord

Allez au Tableau de Bord et connectez-vous avec votre compte Hytale pour gérer vos clés API.

2

Créez une Clé API

Créez une nouvelle clé API depuis le tableau de bord. Le nom de la clé sera affiché aux utilisateurs lors de l'authentification.

3

Créez une Session d'Auth

Faites une requête POST pour créer une session d'authentification. Vous recevrez un ID de session et une URL de connexion pour rediriger les utilisateurs.

4

Obtenez le Résultat

Interrogez l'endpoint de session pour vérifier si l'utilisateur a terminé la connexion. Une fois terminé, vous recevrez les données de profil demandées.

Référence API

Référence complète de l'API d'authentification HyAuth.

POST/api/auth/create

Crée une nouvelle session d'authentification et retourne une URL de connexion pour l'utilisateur.

En-têtes

Authorization: Bearer hy_your_api_key
Content-Type: application/json

Corps de la Requête

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

Réponse

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

Récupère le statut actuel et le résultat d'une session d'authentification.

En-têtes

Authorization: Bearer hy_your_api_key

Réponse — En attente

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

Réponse — Terminé

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

Réponse — Échoué

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

Scopes

Les scopes définissent les données auxquelles votre application peut accéder depuis le compte Hytale de l'utilisateur.

gameProfiles

Accédez aux profils de jeu de l'utilisateur, incluant nom d'utilisateur, UUID et URL du skin.

emailPrivileged

Accédez à l'adresse email de l'utilisateur. C'est un scope privilégié nécessitant une approbation.

Codes d'Erreur

L'API utilise les codes de statut HTTP standard pour indiquer le succès ou l'échec d'une requête.

400

Bad Request — Paramètres manquants ou invalides.

401

Unauthorized — Clé API invalide ou manquante.

403

Forbidden — La clé API n'a pas accès aux scopes demandés.

404

Not Found — L'ID de session n'existe pas.

502

Bad Gateway — Service Hytale en amont indisponible.

Documentation - HyAuth