Game > Gamebase > iOS SDK 사용 가이드 > 인증

Login

Gamebase에서는 게스트 로그인을 기본으로 지원합니다.

• 게스트 이외의 Provider에 로그인하려면 해당 Provider AuthAdapter가 필요합니다.
• AuthAdapter 및 3rd-Party Provider SDK에 대한 설정은 다음을 참고하시기 바랍니다.
  • Game > Gamebase > iOS SDK 사용 가이드 > 시작하기 > 3rd-Party Provider SDK Guide

로그인을 시도하려는 IdP별로, additionalInfo 파라미터를 입력해야 하는 경우가 있습니다.
AdditionalInfo에 대한 설명은 하단의 Gamebase에서 지원 중인 IdP 설명을 참고하시기 바랍니다.

Import Header File

로그인을 구현하고자 하는 ViewController에 다음의 헤더 파일을 가져옵니다.

#import <Gamebase/Gamebase.h>

Login Flow

많은 게임이 타이틀 화면에서 로그인을 구현합니다.

• 앱을 설치하고 처음 실행했을 때 타이틀 화면에서 게임 유저가 어떤 IdP(identity provider)로 인증할지 선택할 수 있게 합니다.
• 한 번 로그인한 후에는 IdP 선택 화면을 표시하지 않고 이전에 로그인한 IdP 유형으로 인증합니다.

위에서 설명한 로직은 다음과 같은 순서로 구현할 수 있습니다.

1. 이전 로그인 유형으로 인증

• 이전에 인증했던 기록이 있다면 ID와 비밀번호를 입력받지 않고 인증을 시도합니다.
• [TCGBGamebase loginForLastLoggedInProviderWithViewController:completion:]을 호출합니다.

1-1. 인증이 성공한 경우

• 축하합니다! 인증에 성공했습니다.
• [TCGBGamebase userID]로 사용자 ID를 획득하여 게임 로직을 구현하시면 됩니다.

1-2. 인증이 실패한 경우

• 네트워크 오류
  • 오류 코드가 TCGB_ERROR_SOCKET_ERROR(110) 또는 TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT(101)인 경우, 일시적인 네트워크 문제로 인증이 실패한 것이므로 [TCGBGamebase loginForLastLoggedInProviderWithViewController:completion:]을 다시 호출하거나, 잠시 후 다시 시도합니다.
• 이용 정지 게임 유저
  • 오류 코드가 TCGB_ERROR_BANNED_MEMBER(7)인 경우, 이용 정지 게임 유저이므로 인증에 실패한 것입니다.
  • [TCGBBanInfo banInfoFromError:error]로 제재 정보를 확인하여 게임 유저에게 게임을 플레이할 수 없는 이유를 알려 주시기 바랍니다.
  • Gamebase 초기화 시 [TCGBConfiguration enablePopup:YES] 및 [TCGBConfiguration enableBanPopup:YES]를 호출한다면 Gamebase가 이용 정지에 관한 팝업 창을 자동으로 띄웁니다.
• 그 외 오류
  • 이전 로그인 유형으로 인증하기가 실패하였습니다. '2. 지정된 IdP로 인증'을 진행합니다.

2. 지정된 IdP로 인증

• IdP 유형을 직접 지정하여 인증을 시도합니다.
  • 인증 가능한 유형은 TCGBConstants.h 파일의 TCGBAuthIdPs에 선언돼 있습니다.
• [TCGBGamebase loginWithType:viewController:completion:] API를 호출합니다.

2-1. 인증에 성공한 경우

• 축하합니다! 인증에 성공했습니다.
• [TCGBGamebase userID]로 사용자 ID를 획득하여 게임 로직을 구현하시면 됩니다.

2-2. 인증에 실패한 경우

• 네트워크 오류
  • 오류 코드가 TCGB_ERROR_SOCKET_ERROR(110) 또는 TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT(101)인 경우, 일시적인 네트워크 문제로 인증에 실패한 것이므로 [TCGBGamebase loginWithType:viewController:completion:]을 다시 호출하거나, 잠시 후 다시 시도합니다.
• 이용 정지 게임 사용자
  • 오류 코드가 TCGB_ERROR_BANNED_MEMBER(7)인 경우, 이용 정지 게임 유저이므로 인증에 실패한 것입니다.
  • [TCGBBanInfo banInfoFromError:error] 로 제재 정보를 확인하여 게임 유저에게 게임을 플레이할 수 없는 이유를 알려 주시기 바랍니다.
  • Gamebase 초기화 시 [TCGBConfiguration enablePopup:YES] 및 [TCGBConfiguration enableBanPopup:YES]를 호출한다면 Gamebase가 이용 정지에 관한 팝업 창을 자동으로 띄웁니다.
• 그 외 오류
  • 오류가 발생했다는 것을 게임 유저에게 알리고, 게임 유저가 인증 IdP 유형을 선택할 수 있는 상태(주로 타이틀 화면 또는 로그인 화면)로 되돌아갑니다.

Login as the Latest Login IdP

가장 최근에 로그인한 IdP로 로그인을 시도합니다. 해당 로그인에 대한 토큰이 만료되었거나, 토큰에 대한 검증 등에 실패하면 실패를 반환합니다.
이때는 해당 IdP에 대한 로그인을 구현해야 합니다.

- (void)automaticLogin {
    [TCGBGamebase loginForLastLoggedInProviderWithViewController:topViewController completion:^(TCGBAuthToken *authToken, TCGBError *error){
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            NSLog(@"Login is succeeded.");
            //TODO: 1. Do you want.
        }
        else {
            if (error.code == TCGB_ERROR_SOCKET_ERROR || error.code == TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT) {
                NSLog(@"Retry loginForLastLoggedInProviderWithViewController:completion: or Notify to user -\n\terror[%@]", [error description]);
                //TODO: 1. If the error had occured by network problem, you can retry by loginForLastLoggedInProviderWithViewController:completion:
            }
            else {
                NSLog(@"Try to login with loginWithType:viewController:completion:");
                // Last Logged In Provider Name
                NSString *lastLoggedInProvider = [TCGBGamebase lastLoggedInProvider];
                if (lastLoggedInProvider == nil || lastLoggedInProvider <= 0) {
                    //TODO: 1. Show your UI what user want to sign in.
                    //2. If the user has selected IdP, set lastLoggedInProvider to it.
                    //3. Invoke loginWithType:viewController:completion: method to try login.
                }

                // Try to login with IdP authentication
                //Warning: If you receive an event asynchronously from async handler(callback), you can use codes below in the async handler.
                [TCGBGamebase loginWithType:lastLoggedInProvider viewController:topViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
                    if ([TCGBGamebase isSuccessWithError:error] == YES) {
                        NSLog(@"Login is succeeded.");
                    }
                    else {
                        NSLog(@"Login is failed.");
                    }
                }];
            }
        }
    }];
}

Login with IdP

특정 IdP 로그인 호출을 위해서 [TCGBGamebase loginWithType:viewController:completion:] 메서드를 호출합니다.
Gamebase를 통하여 로그인을 처음 시도하거나, 로그인 정보(Access Token) 등이 만료되었다면, 이 API를 사용하여 로그인을 시도해야 합니다.
로그인 결과로 (TCGBError *)error 객체를 이용해 성공 여부를 판단할 수 있습니다.
또한 TCGBAuthToken 객체를 이용하여 사용자 ID 등의 사용자 정보 및 토큰 정보를 얻을 수 있습니다.
로그인에 성공하면, Gamebase Access Token이 Local Storage에 저장되며 이후 loginForLastLoggedInProviderWithViewController:completion: 메서드를 사용할 때 저장된 Access Token을 사용하게 됩니다.
하지만 IdP의 Access Token은 각 IdP가 제공하는 SDK가 관리합니다.

[참고]

iOS에서 지원하는 IdP는 TCGBConstants.h의 TCGBAuthIDPs 영역의 kTCGBAuthXXXXXX로 정의되어 있습니다.

[참고]

일부 IdP는 로그인 시 추가 정보가 필요합니다. 추가 정보를 설정할 수 있도록 [TCGBGamebase loginWithType:additionalInfo:viewController:completion:] API를 제공합니다. additionalInfo 파라미터에 필수 정보들을 dictionary 형태로 입력합니다. additionalInfo 값이 있을 경우에는 해당 값을 사용하고 null일 경우에는 NHN Cloud Console에 등록된 값을 사용합니다.

[참고]

LINE IdP는 Gamebase SDK 2.43.0부터 LINE 서비스 제공 지역을 설정할 수 있습니다. 해당 지역은 additionalInfo에 설정할 수 있습니다.

• additionalInfo 파라미터 설정 방법

keyname	a use	값 종류
kTCGBAuthLoginWithCredentialLineChannelRegionKeyname	LINE 서비스 제공 지역 설정	"japan" "thailand" "taiwan" "indonesia"

API

+ (void)loginWithType:(NSString *)type viewController:(UIViewController *)viewController completion:(LoginCompletion)completion;
+ (void)loginWithType:(NSString *)type additionalInfo:(nullable NSDictionary<NSString *, id> *)additionalInfo viewController:(UIViewController *)viewController completion:(LoginCompletion)completion;

Example

- (void)loginFacebookButtonClick {
    [TCGBGamebase loginWithType:kTCGBAuthFacebook viewController:topViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            // To Login Succeeded
            NSString *userId = [authToken.tcgbMember userId];
        } else {
            // To Login Failed
        }
    }];
}

- (void)loginLineButtonClick {
    NSDictionary *additionalInfo = @{ 
        @"key" : @"value" 
    };

    [TCGBGamebase loginWithType:kTCGBAuthLine additionalInfo:additionalInfo viewController:viewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
       if ([TCGBGamebase isSuccessWithError:error] == YES) {
            // To Login Succeeded
            NSString *userId = [authToken.tcgbMember userId];
        } else {
            // To Login Failed
        }
    }];
}

Login with Credential

IdP에서 제공하는 SDK를 사용해 게임에서 직접 인증한 후 발급 받은 Access Token 등을 이용하여, Gamebase에 로그인할 수 있는 인터페이스입니다.

• Credential 파라미터 설정 방법

keyname	a use	값 종류
kTCGBAuthLoginWithCredentialProviderNameKeyname	IdP 유형 설정	facebook, iosgamecenter, naver, google, twitter, line, appleid, hangame, weibo, kakaogame
kTCGBAuthLoginWithCredentialAccessTokenKeyname	IdP 로그인 이후 받은 인증 정보(Access Token) 설정
kTCGBAuthLoginWithCredentialIgnoreAlreadyLoggedInKeyname	Gamebase에 로그인한 상태에서 로그아웃을 하지 않고 다른 계정을 이용해 로그인을 시도하는 것을 허용	BOOL
kTCGBAuthLoginWithCredentialLineChannelRegionKeyname	LINE 서비스 제공 지역 중 로그인을 수행할 하나의 지역	Login with IdP 참고

[참고]

게임 내에서 외부 서비스(Facebook 등)의 고유 기능을 사용해야 할 때 필요할 수 있습니다.

[주의]

외부 SDK에서 요구하는 개발 사항은 외부 SDK의 API를 사용해 구현해야 하며, Gamebase에서는 지원하지 않습니다.

#import "TCGBConstants.h"

- (void)authLoginWithCredential {
    NSDictionary *credentialDic = @{ kTCGBAuthLoginWithCredentialProviderNameKeyname: kTCGBAuthFacebook, kTCGBAuthLoginWithCredentialAccessTokenKeyname:@"여기에 facebook SDK에서 발급 받은 Access Token을 입력하세요" };
    [TCGBGamebase loginWithCredential:credentialDic viewController:parentViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        NSLog([authToken description]);
    }];
}

Authentication Additional Information Settings

Console Guide

Logout

Import Header File

로그아웃을 구현하고자 하는 ViewController에 다음의 헤더 파일을 가져옵니다.

#import <Gamebase/Gamebase.h>

Logout API

로그인된 IdP에서 로그아웃을 시도합니다. 주로 게임의 설정 화면에 로그아웃 버튼을 두고, 버튼을 클릭하면 실행되도록 구현하는 경우가 많습니다. 로그아웃이 성공하더라도, 게임 유저 데이터는 유지됩니다. 로그아웃에 성공하면 해당 IdP로 인증했던 기록을 제거하므로 다음에 로그인할 때 ID, 비밀번호 입력 창이 표시됩니다.

다음은 로그아웃 버튼을 클릭하면 로그아웃이 되는 예시 코드입니다.

- (void)authLogout {
    [TCGBGamebase logoutWithViewController:topViewController completion:^(TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            // To Logout Succeeded
        } else {
            // To Logout Failed
        }
    }];
}

Withdraw

Import Header File

탈퇴를 구현하고자 하는 ViewController에 다음의 헤더 파일을 가져옵니다.

#import <Gamebase/Gamebase.h>

Withdraw API

로그인 상태에서 탈퇴를 시도합니다.

• 탈퇴 성공 시
• 로그인했던 IdP의 게임 이용자 데이터는 삭제됩니다.
• 해당 IdP로 다시 로그인할 수 있으며, 새로운 게임 이용자 데이터를 생성합니다.
• 연동 중인 모든 IdP가 로그아웃 처리됩니다.
• Gamebase 탈퇴를 의미하며, IdP 계정 탈퇴를 의미하지는 않습니다.

[주의]

여러 IdP를 연동 중인 경우, 모든 IdP 연동이 해제되고 Gamebase 유저 데이터가 삭제됩니다.

다음은 탈퇴 버튼을 클릭하면 탈퇴가 되는 예시 코드입니다.

- (void)authWithdrawal {
    [TCGBGamebase withdrawWithViewController:topViewController completion:^(TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            // To Withdrawal Succeeded
        } else {
            // To Withdrawal Failed
        }
    }];
}

Mapping

매핑은 기존에 로그인된 계정에 다른 IdP의 계정을 연동하거나 해제시키는 기능입니다.

대다수의 게임에서는 게임 유저 계정 하나에 여러 IdP를 연동(매핑)할 수 있습니다.
Gamebase의 매핑 API를 사용하면 기존에 로그인된 계정에 다른 IdP 계정을 연동하거나 해제할 수 있습니다.

즉, 연동 중인 IdP 계정으로 로그인을 시도하면 항상 같은 사용자 ID로 로그인됩니다.

주의할 점은, IdP마다 하나의 계정만 연동할 수 있다는 점입니다.
예를 들어 Google 계정을 연동 중이면, 다른 Google 계정을 추가로 연동할 수 없습니다.
계정 연동 예시는 다음과 같습니다.

• Gamebase 사용자 ID: 123bcabca
  • Google ID: aa
  • Facebook ID: bb
  • AppleGameCenter ID: cc
• Gamebase 사용자 ID: 456abcabc
  • Google ID: ee
  • Google ID: ff -> 이미 Google ee 계정이 연동 중이므로 Google 계정을 추가로 연동할 수 없습니다.

매핑 API에는 매핑 추가와 매핑 해제 API가 있습니다.

[주의]

Guest 로그인 중에 매핑을 성공하면 Guest IdP는 사라집니다.

Add Mapping Flow

매핑은 다음 순서로 구현할 수 있습니다.

1. 로그인

매핑은 현재 계정에 IdP 계정 연동을 추가하는 것이므로 우선 로그인이 돼 있어야 합니다. 먼저 로그인 API를 호출해 로그인합니다.

2. 매핑

[TCGBGamebase addMappingWithType:viewController:completion:]을 호출해 매핑을 시도합니다.

2-1. 매핑이 성공한 경우

• 축하합니다! 현재 계정과 연동 중인 IdP 계정이 추가되었습니다.
• 매핑에 성공해도 '현재 로그인 중인 IdP'가 바뀌지는 않습니다. 즉, Gamecenter 계정으로 로그인한 후, Facebook 계정 매핑 시도가 성공했다고 해서 '현재 로그인 중인 IdP'가 Gamecenter에서 Facebook으로 변경되지는 않습니다. Gamecenter 상태로 유지됩니다.
  • [주의]
    : Guest 계정은 예외입니다. Guest 계정으로 로그인한 상태에서 시도한 매핑이 성공했다면 Guest IdP는 삭제되고 '현재 로그인 중인 IdP'도 매핑된 IdP로 변경됩니다.
• 매핑은 단순히 IdP 연동만 추가해 줍니다.

2-2. 매핑이 실패한 경우

• 네트워크 오류
  • 오류 코드가 TCGB_ERROR_SOCKET_ERROR(110) 또는 TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT(101)인 경우, 일시적인 네트워크 문제로 인증이 실패한 것이므로 [TCGBGamebase addMappingWithType:viewController:completion:]을 다시 호출하거나, 잠시 대기했다가 재시도 합니다.
• 이미 다른 계정에 연동 중일 때 발생하는 오류
  • 오류 코드가 TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER(3302)인 경우, 매핑하려는 IdP의 계정이 이미 다른 계정에 연동 중이라는 뜻입니다. 이때 획득한 ForcingMappingTicket으로 강제 매핑([TCGBGamebase addMappingForciblyWithTicket:viewController:completion:])이나 로그인 계정 변경([TCGBGamebase changeLoginWithForcingMappingTicket:viewController:completion:])을 시도할 수 있습니다.
• 이미 동일한 IdP 계정에 연동돼 발생하는 오류
  • 오류 코드가 TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_HAS_SAME_IDP(3303) 인 경우 매핑하려는 IdP와 같은 종류의 계정이 이미 연동 중이라는 뜻입니다.
  • Gamebase 매핑은 한 IdP당 하나의 계정만 연동 가능합니다. 예를 들어 Google 계정에 이미 연동 중이라면 더 이상 Google 계정을 추가할 수 없습니다.
  • 동일 IdP의 다른 계정을 연동하기 위해서는 [TCGBGamebase removeMappingWithType:viewController:completion:]을 호출해 연동을 해제한 후 다시 매핑을 시도하세요.
• 그 외의 오류
  • 매핑 시도가 실패했습니다.

Import Header file into ViewController

매핑을 구현하고자 하는 ViewController에 다음의 헤더 파일을 가져옵니다.

#import <Gamebase/Gamebase.h>

Add Mapping API

특정 IdP에 로그인된 상태에서 다른 IdP로 매핑을 시도합니다.

• additionalInfo 파라미터 설정 방법

keyname	a use	값 종류
kTCGBAuthLoginWithCredentialLineChannelRegionKeyname	LINE 서비스 제공 지역 중 로그인을 수행할 하나의 지역	Login with IdP 참고

API

+ (void)addMappingWithType:(NSString *)type viewController:(UIViewController *)viewController completion:(LoginCompletion)completion;
+ (void)addMappingWithType:(NSString *)type additionalInfo:(nullable NSDictionary<NSString *, id> *)additionalInfo viewController:(UIViewController *)viewController completion:(LoginCompletion)completion;

Example

다음은 Facebook에 매핑을 시도하는 예시입니다.

- (void)authAddMapping {
    [TCGBGamebase addMappingWithType:kTCGBAuthFacebook viewController:parentViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            NSLog(@"AddMapping is succeeded.");
        } else if (error.code == TCGB_ERROR_SOCKET_ERROR || error.code == TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT) {
            NSLog(@"Retry addMapping");
        } else if (error.code == TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER) {
            NSLog(@"Already mapped to other member");
        } else {
            NSLog(@"AddMapping Error - %@", [error description]);
        }
    }];
}

AddMapping with Credential

게임에서 직접 IdP에서 제공하는 SDK로 먼저 인증하고 발급 받은 Access Token 등을 이용하여, Gamebase AddMapping을 할 수 있는 인터페이스입니다.

• Credential 파라미터 설정 방법

keyname	a use	값 종류
kTCGBAuthLoginWithCredentialProviderNameKeyname	IdP 유형 설정	facebook, iosgamecenter, naver, google, twitter, line, appleid
kTCGBAuthLoginWithCredentialAccessTokenKeyname	IdP 로그인 이후 받은 인증 정보(Access Token) 설정

[참고]

게임 내에서 외부 서비스(Facebook 등)의 고유 기능을 사용해야 할 때 필요할 수 있습니다.

[주의]

외부 SDK에서 요구하는 개발 사항은 외부 SDK의 API를 사용해 구현해야 하며, Gamebase에서는 지원하지 않습니다.

API

+ (void)addMappingWithCredential:(NSDictionary *)credentialInfo viewController:(UIViewController *)viewcontroller completion:(LoginCompletion)completion;

Example

- (void)authAddMappingCredential {
    UIViewController* topViewController = nil;

    NSString* facebookAccessToken = @"FACEBOOK_ACCESS_TOKEN";
    NSMutableDictionary* credentialInfo = [NSMutableDictionary dictionary];
    credentialInfo[kTCGBAuthLoginWithCredentialProviderNameKeyname] = kTCGBAuthFacebook;
    credentialInfo[kTCGBAuthLoginWithCredentialAccessTokenKeyname] = facebookAccessToken;

    [TCGBGamebase addMappingWithCredential:credentialInfo viewController:topViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            NSLog(@"AddMapping is succeeded.");
        }
        else if (error.code == TCGB_ERROR_SOCKET_ERROR || error.code == TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT) {
            NSLog(@"Retry addMapping");
        }
        else if (error.code == TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER) {
            NSLog(@"Already mapped to other member");
        }
        else {
            NSLog(@"AddMapping Error - %@", [error description]);
        }
    }];
}

Add Mapping Forcibly

특정 IdP에 이미 매핑되어있는 계정이 있을 때, 강제로 매핑을 시도합니다. 강제 매핑을 시도할 때는 AddMapping API에서 획득한 ForcingMappingTicket이 필요합니다.

API

+ (void)addMappingForciblyWithTicket:(TCGBForcingMappingTicket *)ticket viewController:(nullable UIViewController *)viewController completion:(LoginCompletion)completion;

Example

다음은 Facebook에 강제 매핑을 시도하는 예시입니다.

- (void)authAddMappingForcibly {
    [TCGBGamebase addMappingWithType:kTCGBAuthFacebook viewController:parentViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            NSLog(@"AddMapping is succeeded.");
        } else if (error.code == TCGB_ERROR_SOCKET_ERROR || error.code == TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT) {
            NSLog(@"Retry addMapping");
        } else if (error.code == TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER) {
            NSLog(@"Already mapped to other member");
            TCGBForcingMappingTicket* ticket = [TCGBForcingMappingTicket forcingMappingTicketFromError:error];
            [TCGBGamebase addMappingForciblyWithTicket:ticket viewController:self completion:^(TCGBAuthToken *authToken, TCGBError *error) {
                if ([TCGBGamebase isSuccessWithError:error]) {
                    // Mapping success.
                }
                else {
                    // Mapping failed.
                }
            }];
        } else {
            NSLog(@"AddMapping Error - %@", [error description]);
        }
    }];
}

Change Login with ForcingMappingTicket

특정 IdP에 이미 매핑되어 있는 계정이 있을 때, 로그인 계정을 변경합니다. 로그인 계정을 변경할 때는 AddMapping API에서 획득한 ForcingMappingTicket이 필요합니다.

Change Login API 호출이 실패하는 경우, 이전 계정의 로그인 상태가 유지됩니다.

API

+ (void)changeLoginWithForcingMappingTicket:(TCGBForcingMappingTicket *)ticket viewController:(nullable UIViewController *)viewController completion:(LoginCompletion)completion;

Example

다음은 Facebook에 로그인 계정 변경을 시도하는 예시입니다.

- (void)authChangeLogin {
    [TCGBGamebase addMappingWithType:kTCGBAuthFacebook viewController:parentViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == YES) {
            NSLog(@"AddMapping is succeeded.");
        } else if (error.code == TCGB_ERROR_SOCKET_ERROR || error.code == TCGB_ERROR_SOCKET_RESPONSE_TIMEOUT) {
            NSLog(@"Retry addMapping");
        } else if (error.code == TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER) {
            NSLog(@"Already mapped to other member");
            TCGBForcingMappingTicket* ticket = [TCGBForcingMappingTicket forcingMappingTicketFromError:error];
            [TCGBGamebase changeLoginWithForcingMappingTicket:ticket viewController:self completion:^(TCGBAuthToken *authToken, TCGBError *error) {
                if ([TCGBGamebase isSuccessWithError:error]) {
                    // Change login successed.
                }
                else {
                    // Change login failed.
                    // The login status of the previous account is maintained.
                }
            }];
        } else {
            NSLog(@"AddMapping Error - %@", [error description]);
        }
    }];
}

Remove Mapping API

특정 IdP에 대한 연동을 해제합니다.
만약, 해제하고자 하는 IdP가 유일한 IdP라면, 실패를 반환합니다.
연동 해제 후에는 Gamebase 내부에서, 해당 IdP에 대한 로그아웃을 처리합니다.

[TCGBGamebase removeMappingWithType:kTCGBAuthFacebook viewController:topViewController completion:^(TCGBError *error) {
    if ([TCGBGamebase isSuccessWithError:error] == YES) {
        // To Remove Mapping Succeeded
    } else {
        // To Remove Mapping Failed cause of the error
    }
}];

Get IdP Mapping List

현재의 계정이 어떤 IdP들과 매핑되어 있는지 목록을 확인할 수 있습니다.

// Obtaining Names of Mapping IdPs
NSArray* authMappingList = [TCGBGamebase authMappingList];

Gamebase User`s Information

Gamebase로 인증 절차를 진행한 후, 앱을 제작할 때 필요한 정보를 얻을 수 있습니다.

[주의]

"[TCGBGamebase loginForLastLoggedInProvider]" API로 로그인한 경우에는 인증 정보를 가져올 수 없습니다.

인증 정보가 필요하다면 "[TCGBGamebase loginForLastLoggedInProvider]" 대신, 사용하고자 하는 IDPCode 와 동일한 {IDP_CODE} 를 파라미터로 하여 "[TCGBGamebase loginWithType:IDP_CODE viewController:topViewController completion:completion];" API로 로그인 해야 정상적으로 인증정보를 획득할 수 있습니다.

Get Authentication Information for Gamebase

Gamebase에서 발급한 인증 정보를 가져올 수 있습니다.

// Obtaining Gamebase UserID
NSString* gamebaseUserID = [TCGBGamebase userID];

// Obtaining Gamebase AccessToken
NSString* gamebaseAccessToken = [TCGBGamebase accessToken];

// Obtaining Last Logged In Provider
NSString* lastProviderName = [TCGBGamebase lastLoggedInProvider];

Get Authentication Information for External IdP

• 외부 인증 IdP의 Access Token, 사용자 ID, Profile 등의 정보는 로그인 후 게임 서버에서 Gamebase Server API를 호출하여 가져올 수 있습니다.
  • Game > Gamebase > API 가이드 > Authentication > Get IdP Token and Profiles

[주의]

• 외부 IdP의 인증 정보는 보안을 위해 게임 서버에서 호출할 것을 권장합니다.
• IdP에 따라 Access Token이 빠른 시간에 만료될 수 있습니다.
  • 예를 들어 Google은 로그인 2시간 후에는 Access Token이 만료되어 버립니다.
  • 사용자 정보가 필요하다면 로그인 후 바로 Gamebase Server API를 호출하시기 바랍니다.
• "[TCGBGamebase loginForLastLoggedInProviderWithViewController:completion:]" API로 로그인한 경우에는 인증 정보를 가져올 수 없습니다.
  • 사용자 정보가 필요하다면 "[TCGBGamebase loginForLastLoggedInProviderWithViewController:completion:]" 대신, 사용하고자 하는 IDPCode와 동일한 {IDP_CODE}를 파라미터로 하여 "[TCGBGamebase loginWithType:viewController:completion:]" API로 로그인 해야 합니다.

[주의]

iOS 12 이하 appleid 로그인의 경우 인증 정보를 조회할 수 없습니다.

Get Banned User Information

Gamebase Console에 제재된 게임 유저로 등록될 경우, 로그인을 시도하면 아래와 같은 이용 제한 정보 코드가 표시될 수 있습니다. [TCGBBanInfo banInfoFromError:error] 메서드를 이용해 제재 정보를 확인할 수 있습니다.

• TCGB_ERROR_BANNED_MEMBER

TransferAccount

게스트 계정을 다른 단말기로 이전하기 위해 계정 이전을 위한 키를 발급받는 기능입니다.

이 키를 TransferAccountInfo 라고 부릅니다. 발급 받은 TransferAccountInfo는 다른 단말기에서 requestTransferAccount API를 호출하여 계정 이전을 할 수 있습니다.

[주의]

TransferAccountInfo의 발급은 게스트 로그인 상태에서만 발급이 가능합니다. TransferAccountInfo를 이용한 계정 이전은 게스트 로그인 상태 또는 로그인되어 있지 않은 상태에서만 가능합니다. 로그인한 게스트 계정이 이미 다른 외부 IdP (Google, Facebook 등) 계정과 매핑이 되어 있다면 계정 이전이 지원되지 않습니다.

Issue TransferAccount

게스트 계정 이전을 위한 TransferAccountInfo를 발급합니다.

API

+ (void)issueTransferAccountWithCompletion:(TransferAccountCompletion)completion;

Example

 - (void)issueTransferAccount {
     [TCGBGamebase issueTransferAccountWithCompletion:^(TCGBTransferAccountInfo* transferAccount, TCGBError *error) {
        NSLog(@"Issued TransferAccount => %@, error => %@", [transferAccount description], [error description]);
     }];
 }

Query TransferAccount

게스트 계정 이전을 위해 이미 발급 받은 TransferAccountInfo 정보를 게임베이스 서버에 질의합니다.

API

+ (void)queryTransferAccountWithCompletion:(TransferAccountCompletion)completion;

Example

 - (void)queryTransferAccount {
     [TCGBGamebase queryTransferAccountWithCompletion:^(TCGBTransferAccountInfo* transferAccount, TCGBError *error) {
        NSLog(@"Published TransferAccount => %@, error => %@", [transferAccount description], [error description]);
     }];
 }

Renew TransferAccount

이미 발급 받은 TransferAccountInfo 정보를 갱신합니다. "자동 갱신", "수동 갱신"의 방법이 있으며, "Password만 갱신", "ID와 Password 모두 갱신" 등의 설정을 통해 TransferAccountInfo 정보를 갱신 할 수 있습니다.

+ (void)renewTransferAccountWithConfiguration:(TCGBTransferAccountRenewConfiguration *)config completion:(TransferAccountCompletion)completion;

Example

- (void)renewTransferAccount {
    // If you want renew the account automatically, use this config.
    TCGBTransferAccountRenewalTargetType renewalTargetType = TCGBTransferAccountRenewalTargetTypeIdPassword;
    TCGBTransferAccountRenewConfiguration* autoConfig = [TCGBTransferAccountRenewConfiguration autoRenewConfigurationWithRenewalTarget:renewalTargetType];

    // If you want renew the account manually, use this config.
    TCGBTransferAccountRenewConfiguration* manualConfig = [TCGBTransferAccountRenewConfiguration manualRenewConfigurationWithAccountId:@"ID" accountPassword:@"PASSWORD"];
    [TCGBGamebase renewTransferAccountWithConfiguration:autoConfig completion:^(TCGBTransferAccountInfo *transferAccount, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error]) {
            // Renewing TransferAccount success.
            NSString* accountId = transferAccount.account.accountId;
            NSString* accountPw = transferAccount.account.accountPassword;
            return;
        }
        else {
            // Renewing TransferAccount failed.
        }
    }];
}

Transfer Guest Account to Another Device

issueTransfer API로 발급 받은 TransferAccount를 통해 계정을 이전하는 기능입니다. 계정 이전 성공 시 TransferAccount를 발급 받은 단말기에서 이전 완료 메시지가 표시될 수 있고, 게스트 로그인 시 새로운 계정이 생성됩니다. 계정 이전이 성공한 단말기에서는 TransferAccount를 발급받았던 단말기의 게스트 계정을 계속해서 사용할 수 있습니다.

[주의]

이미 게스트 로그인이 되어 있는 상태에서 이전이 성공하게 되면, 단말기에 로그인되어 있던 게스트 계정은 유실됩니다. 만일 잘못된 id/password를 연속해서 입력하면 AUTH_TRANSFERACCOUNT_BLOCK(3042) 오류가 발생하며 계정 이전이 일정 시간 차단됩니다. 이 경우에는 아래의 예제와 같이 TCGBTransferAccountFailInfo 값을 통해 언제까지 계정 이전이 차단되는지 유저에게 알려줄 수 있습니다.

API

+ (void)transferAccountWithIdPLoginWithAccountId:(NSString *)accountId accountPassword:(NSString *)accountPassword completion:(void(^)(TCGBAuthToken* authToken, TCGBError* error))completion;

Example

 - (void)transferOtherDevice {
    [TCGBGamebase transferAccountWithIdPLoginWithAccountId:@"1Aie0198" accountPassword:@"1Aie0199" completion:^(TCGBAuthToken* authToken, TCGBError* error) {
       if (error.code == TCGB_ERROR_AUTH_TRANSFERACCOUNT_BLOCK) {
            // Transfering Account failed.
            TCGBTransferAccountFailInfo* failInfo = [TCGBTransferAccountFailInfo transferAccountFailInfoFrom:error];
            if (failInfo == nil) {
                // Transfering Account failed by entering the wrong id / pw multiple times.
                // You can tell when the account transfer is blocked by the TransferAccountFailInfo.

                NSString *failedId = failInfo.accountId;
                NSInteger failCount = failInfo.failCount;
                NSDate *blockedDate = [NSDate dateTimeIntervalSince1970:(failInfo.blockEndDate / 1000.0)];
                return;
            }
            // Transfering Account failed by another reason.
            return;  
        }
        // Transfering Account success.
        // TODO: implements post login process
    }];
 }

TemporaryWithdrawal

'탈퇴 유예' 기능입니다. 임시 탈퇴를 요청하여 즉시 탈퇴가 진행되지 않고 일정 기간의 유예 기간이 지나면 탈퇴가 이루어집니다. 유예 기간은 콘솔에서 변경할 수 있습니다.

[주의]

탈퇴 유예 기능을 사용하는 경우에는 [TCGBGamebase withdrawWithViewController:completion:] API를 사용하지 마세요. [TCGBGamebase withdrawWithViewController:completion:] API 는 즉시 계정을 탈퇴합니다.

로그인이 성공하면 AuthToken.getTemporaryWithdrawalInfo() API를 호출하여 탈퇴 유예 상태인 유저인지 판단할 수 있습니다.

Request TemporaryWithdrawal

임시 탈퇴를 요청합니다. 콘솔에 지정된 기간이 지나면 자동으로 탈퇴 진행이 완료됩니다.

API

+ (void)requestTemporaryWithdrawalWithViewController:(nullable UIViewController *)viewController completion:(nullable TemporaryWithdrawCompletion)completion;

ErrorCode

Error Code	Description
TCGB_ERROR_AUTH_WITHDRAW_ALREADY_TEMPORARY_WITHDRAW(3602)	이미 임시 탈퇴를 요청한 유저입니다.

Example

- (void)testRequestWithdraw {
    [TCGBGamebase requestTemporaryWithdrawalWithViewController:parentViewController completion:^(TCGBTemporaryWithdrawalInfo *info, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == NO) {
            if (error.code == TCGB_ERROR_AUTH_WITHDRAW_ALREADY_TEMPORARY_WITHDRAW) {
                // Already requested temporary withdrawal before.
            }
            else {
                // Request temporary withdrawal failed.
                return;
            }
        }

        // Request temporary withdrawal success.
    }];
}

Check TemporaryWithdrawal User

탈퇴 유예를 사용하는 게임은 로그인 후 항상 TCGBAuthToken.tcgbMember.temporaryWithdrawal 를 사용하여, 결과가 null 이 아닌 유효한 TemporaryWithdrawalInfo 객체를 반환한다면 해당 유저에게 탈퇴 진행중이라는 사실을 알려주어야 합니다.

Example

- (void)testLogin {
    [TCGBGamebase loginWithType:@"appleid" viewController:parentViewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == NO) {
            // Login failed
            return;
        }

        // Check if user is requesting withdrawal
        if (authToken.tcgbMember.temporaryWithdrawal != nil) {
            // User is under temporary withdrawal
            long gradePeriod = authToken.tcgbMember.temporaryWithdrawal.gracePeriodDate;
        }
        else {
            // Login Success
        }
    }];
}

Cancel TemporaryWithdrawal

탈퇴 요청을 취소합니다. 탈퇴 요청 후 기간이 만료되어 탈퇴가 완료되면 취소가 불가능합니다.

API

+ (void)cancelTemporaryWithdrawalWithViewController:(UIViewController *)viewController completion:(WithdrawCompletion)completion;

ErrorCode

Error Code	Description
TCGB_ERROR_AUTH_WITHDRAW_NOT_TEMPORARY_WITHDRAW(3603)	임시 탈퇴를 요청한 유저가 아닙니다.

Example

- (void)testCancelWithdraw {
    [TCGBGamebase cancelTemporaryWithdrawalWithViewController:parentViewController completion:^(TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == NO) {
            if (error.code == TCGB_ERROR_AUTH_WITHDRAW_NOT_TEMPORARY_WITHDRAW) {
                // Never requested temporary withdrawal before.
            }
            else {
                // Cancel temporary withdrawal failed.
                return
            }
        }

        // Cancel temporary withdrawal success.
    }];
}

Withdraw Immediately

탈퇴 유예 기간을 무시하고 즉시 탈퇴를 진행합니다. 실제 내부 동작은 [TCGBGamebase withdrawWithViewController:completion:] API 와 동일합니다.

즉시 탈퇴는 취소가 불가능하므로 유저에게 실행 여부를 거듭 확인하시기 바랍니다.

API

+ (void)withdrawImmediatelyWithViewController:(UIViewController *)viewController completion:(WithdrawCompletion)completion;

Example

- (void)testWithdrawImmediately {
    [TCGBGamebase withdrawImmediatelyWithViewController:parentViewController completion:^(TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == NO) {
            // withdraw failed.
            return;
        }

        // Withdraw success.
    }];
}

GraceBan

• '결제 어뷰징 자동 해제' 기능입니다.
  • 결제 어뷰징 자동 해제 기능은 결제 어뷰징 자동 제재로 이용 정지가 되어야 할 사용자가 '이용 정지 유예 상태' 후 이용 정지가 되도록 합니다.
  • '이용 정지 유예 상태'일 경우, 설정한 기간 내에 이용 정지 해제 조건을 모두 만족하면 정상적으로 플레이할 수 있습니다.
  • 기간 내에 조건을 충족하지 못하면 이용 정지가 됩니다.
• 결제 어뷰징 자동 해제 기능을 사용하는 게임은 로그인 후 항상 TCGBAuthToken.tcgbMember.graceBanInfo 값을 확인하고, null이 아닌 유효한 TCGBGraceBanInfo 객체를 반환한다면 해당 유저에게 이용 정지 해제 조건, 기간 등을 안내해야 합니다.
  • 이용 정지 유예 상태인 유저의 게임 내 접근 제어는 게임에서 처리해야 합니다.

Example

- (void)testGraceBanInfo {
    [TCGBGamebase loginWithType:kTCGBAuthAppleID viewController:viewController completion:^(TCGBAuthToken *authToken, TCGBError *error) {
        if ([TCGBGamebase isSuccessWithError:error] == NO) {
            // Login failed
            return;
        }

        // Check if user is under grace ban
        if (authToken.tcgbMember.graceBanInfo != nil) {
            TCGBGraceBanInfo *graceBanInfo = authToken.tcgbMember.graceBanInfo;
            // gracePeriodDate: epoch time in milliseconds
            long long gracePeriodDate = graceBanInfo.gracePeriodDate;
            NSString *message = [graceBanInfo.message stringByRemovingPercentEncoding];
            if (graceBanInfo.paymentStatus != nil) {
                TCGBPaymentStatus *paymentStatus = graceBanInfo.paymentStatus;
                double paymentStatusAmount = paymentStatus.amount;
                int paymentStatusCount = paymentStatus.count;
            }
            if (graceBanInfo.releaseRuleCondition != nil) {
                TCGBReleaseRuleCondition *releaseRuleCondition = graceBanInfo.releaseRuleCondition;
                double releaseRuleConditionAmount = releaseRuleCondition.amount;
                int releaseRuleConditionCount = releaseRuleCondition.count;
                NSString *releaseRuleConditionCurrency = releaseRuleCondition.currency;
                // condition type: "AND", "OR"
                NSString *releaseRuleConditionType = releaseRuleCondition.conditionType;
            }
            // Guide the user through the UI how to finish the grace ban status.
        }
        else {
            // Login Success
        }
    }];
}

Error Handling

Category	Error	Error Code	Description
Auth	TCGB_ERROR_INVALID_MEMBER	6	잘못된 회원에 대한 요청입니다.
	TCGB_ERROR_BANNED_MEMBER	7	제재된 회원입니다.
	TCGB_ERROR_AUTH_USER_CANCELED	3001	로그인이 취소되었습니다.
	TCGB_ERROR_AUTH_NOT_SUPPORTED_PROVIDER	3002	지원하지 않는 인증 방식입니다.
	TCGB_ERROR_AUTH_NOT_EXIST_MEMBER	3003	존재하지 않거나 탈퇴한 회원입니다.
	TCGB_ERROR_AUTH_EXTERNAL_LIBRARY_INITIALIZATION_ERROR	3006	외부 인증 라이브러리 초기화에 실패하였습니다.
	TCGB_ERROR_AUTH_EXTERNAL_LIBRARY_ERROR	3009	외부 인증 라이브러리 오류입니다. 상세 오류를 확인하십시오.
	TCGB_ERROR_AUTH_INVALID_GAMEBASE_TOKEN	3011	Gamebase Access Token이 유효하지 않아 로그아웃되었습니다. 로그인을 다시 시도하십시오.
Auth (Login)	TCGB_ERROR_AUTH_TOKEN_LOGIN_FAILED	3101	토큰 로그인에 실패했습니다.
	TCGB_ERROR_AUTH_TOKEN_LOGIN_INVALID_TOKEN_INFO	3102	토큰 정보가 유효하지 않습니다.
	TCGB_ERROR_AUTH_TOKEN_LOGIN_INVALID_LAST_LOGGED_IN_IDP	3103	최근에 로그인한 IdP 정보가 없습니다.
IdP Login	TCGB_ERROR_AUTH_IDP_LOGIN_FAILED	3201	IdP 로그인에 실패하였습니다.
	TCGB_ERROR_AUTH_IDP_LOGIN_INVALID_IDP_INFO	3202	IdP 정보가 유효하지 않습니다. (Console에 해당 IdP 정보가 없습니다.)
	TCGB_ERROR_AUTH_IDP_LOGIN_EXTERNAL_AUTHENTICATION_REQUIRED	3203	Gamebase 로그인 요청 전에 먼저 IdP 로그인이 되어 있어야 합니다.
Add Mapping	TCGB_ERROR_AUTH_ADD_MAPPING_FAILED	3301	매핑 추가에 실패했습니다.
	TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_MAPPED_TO_OTHER_MEMBER	3302	이미 다른 멤버에 매핑돼 있습니다.
	TCGB_ERROR_AUTH_ADD_MAPPING_ALREADY_HAS_SAME_IDP	3303	이미 같은 IdP에 매핑돼 있습니다.
	TCGB_ERROR_AUTH_ADD_MAPPING_INVALID_IDP_INFO	3304	IdP 정보가 유효하지 않습니다. (Console에 해당 IdP 정보가 없습니다.)
	TCGB_ERROR_AUTH_ADD_MAPPING_CANNOT_ADD_GUEST_IDP	3305	게스트 IdP로는 AddMapping이 불가능합니다.
Remove Mapping	TCGB_ERROR_AUTH_REMOVE_MAPPING_FAILED	3401	맵핑 삭제에 실패했습니다.
	TCGB_ERROR_AUTH_REMOVE_MAPPING_LAST_MAPPED_IDP	3402	마지막에 맵핑된 IdP는 삭제할 수 없습니다.
	TCGB_ERROR_AUTH_REMOVE_MAPPING_LOGGED_IN_IDP	3403	현재 로그인되어 있는 IdP입니다.
Logout	TCGB_ERROR_AUTH_LOGOUT_FAILED	3501	로그아웃에 실패했습니다.
Withdrawal	TCGB_ERROR_AUTH_WITHDRAW_FAILED	3601	탈퇴에 실패했습니다.
	TCGB_ERROR_AUTH_WITHDRAW_ALREADY_TEMPORARY_WITHDRAW	3602	이미 임시 탈퇴를 요청한 유저입니다.
	TCGB_ERROR_AUTH_WITHDRAW_NOT_TEMPORARY_WITHDRAW	3603	임시 탈퇴를 요청한 유저가 아닙니다.
Not Playable	TCGB_ERROR_AUTH_NOT_PLAYABLE	3701	플레이할 수 없는 상태입니다 (점검 또는 서비스 종료 등).
Auth(Unknown)	TCGB_ERROR_AUTH_UNKNOWN_ERROR	3999	알수 없는 오류입니다. (정의되지 않은 오류입니다.)

• 전체 오류 코드는 다음 문서를 참고하시기 바랍니다.
  • 오류 코드

TCGB_ERROR_AUTH_EXTERNAL_LIBRARY_ERROR

• 이 오류는 외부 인증 라이브러리에서 오류가 발생했을 때 반환됩니다.
• 외부 인증 라이브러리에서 발생한 오류 정보는 상세 오류에 포함되어 있으며 상세한 오류 코드 및 메시지는 다음과 같이 확인할 수 있습니다.

TCGBError *tcgbError = error; // TCGBError object via callback

NSInteger detailErrorCode = [error detailErrorCode];
NSString *detailErrorMessage = [error detailErrorMessage];

// If you use **description** method, you can get entire information of this object by JSON Format
NSLog(@"TCGBError: %@", [tcgbError description]);

• 상세 오류 코드는 각각의 외부 인증 라이브러리의 Developer 페이지를 참고하시기 바랍니다.