Skip to content

iOS

This guide provides instructions for setting up the Hive SDK authentication feature on iOS.

Feature addition

Add the authentication feature framework to the Podfile in the project directory. Only add the authentication features you want to use.

To use the Device Management Service, add the following framework.

pod 'HiveDeviceManagement', $HIVE_SDK_VERSION # 앱 사용자의 기기 관리를 위한 프레임워크

To use Google Recaptcha in guest login, add the following framework.

pod 'HiveGoogleRecaptcha', $HIVE_SDK_VERSION # 게스트 로그인시 봇 점수 기반의 Google reCAPTCHA Enterprise 기능을 사용하기 위한 프레임워크

Based on the relevant regulations such as the [Notice on Stricter Management of Online Game Addiction for Minors] announced by the National Press and Publication Administration of China, to use the function that requires users accessing from China who have games licensed in China to undergo real-name verification, please add the framework below.

pod 'HiveRealNameVerification', $HIVE_SDK_VERSION # 실명 인증 서비스 추가


After saving the Podfile with the added framework, run the command below to install the framework in the project.

pod install

Add IdP

Add the IdP framework to the Podfile in the project directory. Only add the IdP you will use.


Below is an example of adding frameworks to the Podfile of the project directory. The Guest Login feature can be used without adding any frameworks.

pod 'HiveAuthV4ProviderAppleSignIn', $HIVE_SDK_VERSION # Signin with Apple 로그인
pod 'HiveAuthV4ProviderFacebook', $HIVE_SDK_VERSION # Facebook IdP, Social Facebook 기능
pod 'HiveAuthV4ProviderQQ', $HIVE_SDK_VERSION # QQ IdP
pod 'HiveAuthV4ProviderVK', $HIVE_SDK_VERSION # VK IdP
pod 'HiveAuthV4ProviderWechat', $HIVE_SDK_VERSION # WeChat IdP
pod 'HiveAuthV4ProviderGoogle', $HIVE_SDK_VERSION # Google IdP
pod 'HiveAuthV4ProviderAppleGameCenter', $HIVE_SDK_VERSION # Apple Game Center IdP
pod 'HiveAuthV4ProviderHive', $HIVE_SDK_VERSION # Hive 멤버십 로그인, Social Hive 기능
pod 'HiveAuthV4ProviderWeverse', $HIVE_SDK_VERSION # Weverse IdP
pod 'HiveAuthV4ProviderSteam', $HIVE_SDK_VERSION # Steam IdP
pod 'HiveAuthV4ProviderX', $HIVE_SDK_VERSION # X IdP

If you are using Line IDP and targeting iOS 13 or lower, only add the following framework.

pod 'HiveAuthV4ProviderLine', $HIVE_SDK_VERSION # LINE IdP

If you are using iOS 13 or later, add the following frameworks.

pod 'HiveAuthV4ProviderLine', $HIVE_SDK_VERSION # LINE IdP
pod 'HiveAuthV4ProviderLine/LineSDKSwift11', $HIVE_SDK_VERSION # LINE IdP(5.11.0 / iOS 13 이상)

After saving the Podfile with the added framework, run the command below to install the framework in the project.

pod install

Additional settings by IdP

Additional configuration is required depending on the IdP.

Signin sith Apple IdP settings

This guide provides instructions for setting up Signin With Apple IdP. Follow the steps below to add Apple login to the IdP list.

  1. Select your project in the project navigator of the Xcode project window.\n2. Choose your app from the TARGETS list.\n3. Click on the Signing & Capabilities tab.\n4. Click the + Capability button at the top left of the Signing & Capabilities tab.\n5. Select Sign In with Apple from the list to add it.

    6. You can see Sign In with Apple added to the Signing & Capabilities list.

Apple Game Center IdP settings

This is a guide for setting up Apple Game Center IdP. Follow the steps below to add Apple Game Center login to the IdP list.

  1. In the Xcode project window, select your project in the project navigator.\n2. Select your app from the TARGETS list.\n3. Click on the Signing & Capabilities tab.\n4. Click the + Capability button in the top left corner of the Signing & Capabilities tab.\n5. Select GameCenter from the list to add it.

You can check the Game Center added to the Signing & Capabilities list.

Facebook IdP settings

This is a guide for setting up Facebook IdP.

Enter Facebook AppID and ClientToken

Follow the instructions below to enter the Facebook AppID and ClientToken in the Xcode project.

  1. Select your project in the project navigator of the Xcode project window.\n2. Choose your app from the TARGETS list.\n3. Click on the Info tab.\n4. In the Info tab, click on the Custom iOS Target Properties item and enter the Facebook App ID in the FacebookAppID property.

    5. In the Facebook console App Dashboard, go to Settings > Advanced > Security > Client Token to check the FacebookClientToken. 6. Click on the Custom iOS Target Properties item in the Info tab and enter the FacebookClientToken in the FacebookClientToken property. 7. Click on the URL Types item in the Info tab, then click the + icon to create an Additional url type properties item. 8. In the Additional url type properties item, enter the Facebook AppID with fb appended in the URL Schemes field (e.g., fb012342478841523).

Add Facebook scheme to whitelist

To add the Facebook Scheme to the whitelist, you can use the project window or directly add the code to the Info.plist file.

Note

Starting from iOS 9, switching to external apps is only allowed for schemes that are added to the whitelist. In the iOS 9 environment, when a user logs into Facebook from your game, the Hive platform utilizes the Safari view controller to perform Facebook login through the Safari web view. Therefore, switching from the game app to the Facebook app does not occur, and login can be handled using the in-app browser. Facebook recommends that the Facebook Scheme be registered by default on the whitelist. View Facebook SDK Documentation

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click on the Info tab.
  4. In the Info tab, click on LSApplicationQueriesSchemes and click the + button to add the following two schemes:
    • fbapi
    • fb-messenger-share-api


There is also a way to directly add the code below to Info.plist.

"LSApplicationQueriesSchemes" : [
 "fbapi", 
 "fb-messenger-share-api"
]

QQ IdP settings

This is a guide for setting up QQ IdP.

Add QQ scheme to the whitelist

To add the QQ Scheme to the whitelist, you can use the project window or directly add the code to the Info.plist file.

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click the Info tab.
  4. In the Info tab, click LSApplicationQueriesSchemes and click the + button to add the following schemes:
    • mqqOpensdkSSoLogin
    • mqqopensdkapiV2
    • mqqopensdkapiV3
    • wtloginmqq2
    • mqq
    • mqqapi
    • mqqopensdknopasteboard
    • mqqopensdknopasteboardios16

There is also a way to directly add the code below to Info.plist.

"LSApplicationQueriesSchemes" : [
 "mqqOpensdkSSoLogin",
 "mqqopensdkapiV2",
 "mqqopensdkapiV3",
 "wtloginmqq2",
 "mqq",
 "mqqapi"
]

VK IdP settings

This is a guide for setting up VK IdP.

Enter VK AppID

Follow the instructions below to enter the VK AppID in the Xcode project.

  1. In the Xcode project window, select your project in the project navigator.
  2. Select your app from the TARGETS list.
  3. Click on the Info tab.
  4. In the Info tab, click on the Custom iOS Target Properties item and add VK data to LSApplicationQueriesSchemes (vkauthorize, vk-share, vk).
  5. In the Info tab, click on the URL Types item, then click the + icon to create an Additional url type properties item.
  6. Under the Additional url type properties item, enter the VK AppID with the vk prefix in the URL Schemes field (e.g., Vk1231234).

WeChat IdP settings

This is a guide for setting up WeChat IdP.

Enter WeChat AppID

Follow the instructions below to enter the WeChat AppID in the Xcode project.

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click on the Info tab.
  4. Click on the URL Types section within the Info tab, then click the + icon to create an Additional url type properties entry.
  5. In the URL Schemes field under the Additional url type properties entry, enter Identifier: weixin, weixinULAPI, URL Schemes: APP_ID.
Note

When using WeChat IdP and Hive SDK promotion together, you must apply the Universal Link.

Google IdP configuration

This is a guide for setting up Google IdP.

Enter reversed Client ID

Follow the instructions below to enter the Reversed Client ID in your Xcode project.

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click on the Info tab.
  4. Click on the URL Types section within the Info tab, then click the + icon to create an Additional url type properties entry.
  5. In the URL Schemes field under the Additional url type properties entry, enter Identifier as a space, and URL Schemes as reversed client ID.

Line IdP configuration

This is a guide for setting up Line IdP.

Modify podfile

When using Line IdP, you need to add the following content to the post_install code in the Podfile of the project directory.

post_install do |installer|
   installer.pods_project.targets.each do |target|
       target.build_configurations.each do |config|
            ...
            # LineSDKSwift 사용 시 pod project 설정 변경필요
           if ['LineSDKSwift'].include? target.name
               config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
           # Xcode 14 에서 발생하는 CocoaPods bundle 타겟에 대한 Code signing 컴파일 에러 이슈 대응
           elsif config.build_settings['WRAPPER_EXTENSION'] == 'bundle'
               config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
           end
            ...
       end
   end
end

After saving the modified Podfile as above, run the command below to install the framework in the project.

pod install

Enter App bundle ID

Follow the instructions below to enter the app bundle ID in your Xcode project.

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click on the Info tab.
  4. Click on the Custom iOS Target Properties item in the Info tab and add LINE data (lineauth2) to LSApplicationQueriesSchemes.
  5. Click on the URL Types item in the Info tab, then click the + icon to create an Additional url type properties item.
  6. In the URL Schemes field under the Additional url type properties item, enter the app bundle ID prefixed with line3rdp (e.g., line3rdp.$(PRODUCT\_BUNDLE\_IDENTIFIER)).
Warning

After implementing the login feature with LINE, you must also add it to the IdP connection status information.

X IdP configuration

This is a guide for configuring the X IdP.

Enter App bundle ID

Follow the instructions below to enter the app bundle AppID in the Xcode project.

  1. Select your project in the project navigator of the Xcode project window.
  2. Choose your app from the TARGETS list.
  3. Click on the Info tab.
  4. Click on the URL Types section within the Info tab, then click the + icon to create an Additional url type properties entry.
  5. In the URL Schemes field under the Additional url type properties entry, enter the app bundle ID with the hive.x prefix (e.g., hive.x.$(PRODUCT\_BUNDLE\_IDENTIFIER)).