HYAUTHDashboard

Primeiros Passos

Integre o HyAuth na sua aplicação em poucos passos simples.

1

Entre no Painel

Vá ao Painel de Controlo e entre com a sua conta Hytale para gerir as suas chaves API.

2

Crie uma Chave API

Crie uma nova chave API no painel. O nome da chave será apresentado aos utilizadores durante a autenticação.

3

Crie uma Sessão de Auth

Faça um pedido POST para criar uma sessão de autenticação. Receberá um ID de sessão e um URL de início de sessão para redirecionar os utilizadores.

4

Obtenha o Resultado

Consulte o endpoint da sessão para verificar se o utilizador concluiu o início de sessão. Uma vez concluído, receberá os dados de perfil solicitados.

Referência da API

Referência completa da API de autenticação HyAuth.

POST/api/auth/create

Cria uma nova sessão de autenticação e devolve um URL de início de sessão para o utilizador.

Cabeçalhos

Authorization: Bearer hy_your_api_key
Content-Type: application/json

Corpo do Pedido

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

Resposta

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

Obtém o estado atual e o resultado de uma sessão de autenticação.

Cabeçalhos

Authorization: Bearer hy_your_api_key

Resposta — Pendente

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

Resposta — Concluído

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

Resposta — Falhou

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

Âmbitos

Os âmbitos definem quais dados a sua aplicação pode aceder da conta Hytale do utilizador.

gameProfiles

Aceda aos perfis de jogo do utilizador incluindo nome de utilizador, UUID e URL do skin.

emailPrivileged

Aceda ao endereço de email do utilizador. Este é um âmbito privilegiado que requer aprovação.

Códigos de Erro

A API utiliza códigos de estado HTTP padrão para indicar o sucesso ou falha de um pedido.

400

Bad Request — Parâmetros em falta ou inválidos.

401

Unauthorized — Chave API inválida ou em falta.

403

Forbidden — A chave API não tem acesso aos âmbitos solicitados.

404

Not Found — O ID da sessão não existe.

502

Bad Gateway — Serviço Hytale upstream indisponível.

Documentação - HyAuth