시작하기¶

웹 로그인 은 유저가 커뮤니티 및 블록체인과 같은 다양한 웹에서 IdP로 로그인할 수 있는 기능입니다. 웹 로그인이 가능한 IdP를 참고하세요.

웹 로그인 API를 사용하면 유저가 앱이 아닌 외부의 웹 사이트(예: 게임 개발사가 운영하는 커뮤니티 사이트)에서 IdP 로그인하도록 구현할 수 있습니다. 현재 웹 로그인 API는 기존의 웹 로그인 v1과 웹 로그인 v2을 통합하여 제공합니다.

사전 준비 사항¶

웹 로그인의 동작 방식에 따른 사전 준비 사항을 안내합니다.

웹 로그인의 동작 방식에는 크게 게임 PlayerID를 식별자로 사용하여 로그인하는 방식과 별도 유저 식별자를 생성하여 로그인하는 방식이 있습니다.

게임 PlayerID를 식별자로 웹 로그인¶

게임 PlayerID를 식별자로 웹 로그인하는 동작 방식은 아래와 같습니다.

• 블록체인과 같이 SDK를 적용하지 않은 웹에서 유저 식별자를 PlayerID로 사용하여 로그인을 처리합니다.
• 최초 IdP 연동 시 유저 식별자인 PlayerID는 웹 로그인 시 직접 생성합니다.
• 최초 IdP 연동은 게임에서만 진행해야 합니다. 그렇지 않으면 계정 충돌이 발생할 수 있습니다.
• XPLA 게임즈 월렛을 사용하면 로그인 화면은 SMS 인증을 진행한 후에 노출됩니다.

게임 PlayerID를 식별자로 사용하여 웹 로그인하기 위한 준비 사항은 아래와 같습니다.

1. 콘솔 > 앱센터에서 AppID 생성
   웹 로그인을 사용하려면 우선 콘솔의 앱센터에서 AppID를 생성해야 합니다. AppID 등록하기를 참고하세요.

2. 콘솔 > 인증에서 로그인 설정
   AppID를 생성하였으면 인증 >로그인 설정에서 웹 로그인으로 사용할 IdP를 선택하고 인증 키를 등록합니다. 웹 로그인에서는 게스트 로그인을 지원하지 않습니다.
   인증 키 등록 시 필요한 설정 항목은 아래와 같습니다.

   • 회원가입 여부 등록: 웹 로그인 IdP로 Hive 웹로그인 을 선택 시 회원 가입 사용 여부 를 설정할 수 있습니다.
     • 회원 가입 사용 선택 시: 최초 IdP 연동이 웹 로그인에서 가능하나, 계정 충돌이 발생할 수 있음
     • 회원 가입 사용 안함 선택 시: 최초 IdP 연동은 게임에서만 가능함
   • Redirect URI 등록: 웹 로그인인 완료된 후 이동될 도착지 웹 주소를 등록합니다. 최대 5개까지 등록할 수 있습니다.
   Note

   계정 충돌은 웹 로그인을 통해 최초로 IdP가 연동되어 PlayerID가 생성된 상태에서, Hive SDK가 적용된 게임에서 로그인 후 게임 프로필에서 추가 IdP 연동을 시도할 때 발생합니다. 이 경우 이미 웹 로그인을 통해 생성된 PlayerID가 있기 때문에, 유저에게 어떤 계정을 사용할지 선택하라는 계정 충돌 안내가 표시됩니다.

3. IdP 콘솔 설정
   사용할 IdP 콘솔에 웹 로그인 도메인 주소로 Redirect URI을 등록합니다. 해당 과정은 웹 로그인 동작 방식에 관계없이 공통 사항으로 자세한 내용은 IdP 콘솔에 Redirect URI 등록을 참고하세요.

별도 유저 식별자를 생성하여 웹 로그인¶

별도 유저 식별자를 생성하여 웹 로그인하는 동작 방식은 아래와 같습니다.

• 최초 IdP 연동 시 유저 식별자를 사용 제품에서 생성하므로 계정 충돌 상황을 방지할 수 있습니다.
• 유저 식별자를 제품에서 생성하기 때문에 다양한 곳에서 사용할 수 있으며, 계정 충돌이 발생하지 않습니다. 게임에서 생성된 PlayerID를 연결하려면 Server API를 사용합니다.

별도 유저 식별자를 생성하여 웹 로그인하기 위한 준비 사항은 아래와 같습니다.

1. 앱센터에서 AppID 생성
   웹 로그인을 사용하려면 앱센터 AppID를 생성해야 합니다. 앱센터 AppID 등록하기 콘솔 가이드를 참고하세요.

2. 콘솔 > 인증에서 로그인 설정
   AppID를 생성하였으면 인증 >로그인 설정에서 웹 로그인으로 지원하는 IdP 선택 및 인증 키를 등록합니다. 웹 로그인에서는 게스트 로그인을 지원하지 않습니다.

   • 회원가입 여부 등록: 웹 로그인 IdP로 Hive 웹로그인 을 선택 시 회원 가입 사용 여부 를 설정할 수 있습니다.

     • 회원 가입 사용 선택 시: 최초 IdP 연동이 웹 로그인에서 가능함
     • 회원 가입 사용 안함 선택 시: 최초 IdP 연동은 게임에서만 가능함

   • Redirect URI 등록: 웹 로그인인 완료된 후 이동될 도착지 웹 주소를 등록합니다. 최대 5개까지 등록할 수 있습니다.

3. IdP 콘솔 설정
   사용할 IdP 콘솔에 웹 로그인 도메인 주소로 Redirect URI을 등록합니다. 해당 과정은 웹 로그인 동작 방식에 관계없이 공통 사항으로 자세한 내용은 IdP 콘솔에 Redirect URI 등록을 참고하세요.

IdP 콘솔에 Redirect URI 등록¶

인증 > 로그인 설정에서 웹 로그인 종류를 선택하고 인증 키를 등록했다면 Google, Apple 등과 같은 IdP 콘솔에 웹 로그인 도메인 주소로 Redirect URI를 직접 등록해야 합니다.

Google¶

Google Cloud Console에 접속하여 프로젝트에서 OAuth 클라이언트 ID를 생성하고, Redirect URI를 등록합니다. 자세한 내용은 Google Developers 문서를 참고하세요.

• 등록할 Redirect URI
  • sandbox: https://sandbox-weblogin.withhive.com/cb_google
  • real: https://weblogin.withhive.com/cb_google

Facebook¶

Meta for Developers에 접속하여 앱 내에서 Facebook 로그인 설정을 추가한 후, Redirect URI를 등록합니다. 자세한 내용은 Meta Developers 문서를 참고하세요.

• 등록할 Redirect URI
  • sandbox: https://sandbox-weblogin.withhive.com/cb_facebook
  • real: https://weblogin.withhive.com/cb_facebook

Apple¶

Apple Developer Console에 접속하여 Services IDs를 생성한 후, Sign in with Apple 설정에서 Return URLs를 등록합니다. 자세한 내용은 Apple Developer 문서를 참고하세요.

• 등록할 Redirect URI
  • sandbox: https://sandbox-weblogin.withhive.com/cb_apple
  • real: https://weblogin.withhive.com/cb_apple

웹 로그인 API 사용 방법¶

위 사전 준비 사항을 완료하면 아래의 API를 호출하여 웹 로그인을 구현할 수 있습니다.

• 로그인 페이지 호출
• 로그인 검증 및 유저 정보 조회
• 토큰 갱신
• 인증 API로 유저 정보 조회
• 로그인 유지 (SSO)

웹 로그인 API는 '웹 로그인 AppID'의 사용 용도에 따라 사용 방법이 상이합니다.

'웹 로그인 AppID' 사용 용도가 '커뮤니티' 또는 '웹사이트'인 경우¶

하이브 콘솔의 앱센터 > AppID 관리 > 웹 로그인 AppID 등록에서 '웹 로그인 AppID'의 사용 용도를 커뮤니티 또는 웹사이트로 선택하는 경우, 게임 개발사에서는 웹 로그인 API를 아래와 같이 사용합니다.

1. 로그인 페이지 호출
2. 로그인 검증 및 유저 정보 조회 API의 응답 값인 IdP 식별자(idp_index, idp_user_id) 값을 사용자 계정 식별자로 활용 및 개발사 데이터베이스에 저장

위와 같이 사용하는 이유는 게임이 아닌 커뮤니티 또는 웹사이트에서 먼저 IdP로 로그인하면 게임에서 사용하는 사용자 식별자인 PlayerID를 생성하지 않기 때문입니다. PlayerID 대신 IdP 식별자를 사용자 계정 식별자로 활용하면 계정 충돌 을 방지할 수 있습니다.

단, 사용자가 게임 앱에 접속해 로그인하면 게임 사용자 식별자인 PlayerID가 생성되므로 검증 및 유저 정보 조회 API의 응답 값인 user_info의 PlayerID 또는 인증 API로 유저 정보 조회 API의 응답 값인 PlayerID와 구분하여 사용자 계정 식별자로 사용할 수 있습니다.

'웹 로그인 AppID' 사용 용도가 '블록체인'인 경우¶

하이브 콘솔의 앱센터 > AppID 관리 > 웹 로그인 AppID 등록에서 '웹 로그인 AppID'의 사용 용도를 '블록체인'으로 선택하는 경우, 게임 개발사에서는 웹 로그인 API를 아래와 같이 사용합니다.

1. 로그인 페이지 호출
2. 로그인 검증 및 유저 정보 조회 호출 및 응답 값인 PlayerID 값으로 사용자 계정 식별 가능 (IdP 식별자와 같은 별도 식별자를 획득 및 관리할 필요가 없음)

즉, 블록체인의 경우 로그인 페이지 호출 및 로그인 검증 및 유저 정보 조회를 호출하면 PlayerID가 생성되므로, 커뮤니티 또는 웹사이트처럼 별도 IdP 식별자를 사용하지 않아도 됩니다.