iOS

本文旨在介绍如何设置 Ubisoft 身份验证，让您的游戏可以使用 Player Network 登录鉴权服务通过 Ubisoft 渠道登录。

前提条件

1. 设置 Ubisoft 应用

联系 Ubisoft 获取以下应用程序配置参数。

1. App ID
2. GENOME ID
3. 游戏 SKU
4. 登录页面 URL

2. 获取 Player Network 控制台登录账号。
3. 为游戏创建新项目，或加入已有项目。
4. 下载 SDK。
5. 接入 SDK。
6. 在 Player Network 控制台添加 Ubisoft 为业务的登录鉴权方式。

步骤1: 配置SDK

警告

Ubisoft SDK 仅与 iOS SDK 12 及以上版本兼容。

IDE: Xcode 13.3 或更高版本
iOS: iOS 12.0 或更高版本

1. 在 INTLConfig.ini 文件中添加应用程序配置参数。

   [Ubisoft]
   UBI_APP_ID_IOS = {INTL_UBI_APP_ID_IOS}
   UBI_GENOME_ID_IOS = {INTL_UBI_GENOME_ID_IOS}
   UBI_APP_BUILDID_IOS = {INTL_UBI_APP_BUILDID_IOS}
   UBI_GAME_VERSION_IOS = {INTL_UBI_GAME_VERSION_IOS}
   UBI_SKU = {INTL_UBI_SKU}
   UBI_WEB_AUTH_URL = {INTL_UBI_WEB_AUTH_URL}
   • 将 {INTL_UBI_APP_ID_IOS} 替换为 Ubisoft 提供的 App ID。
   • 将 {INTL_UBI_GENOME_ID_IOS} 替换为 Ubisoft 提供的 GENOME ID。
   • 将 {INTL_UBI_APP_BUILDID_IOS} 替换为游戏 iOS 版本号。
   • 将 {INTL_UBI_GAME_VERSION_IOS} 替换为游戏的自定义版本类型，例如 Alpha、Beta、Test 和 Full。
   • 将 {INTL_UBI_SKU} 替换为 Ubisoft 提供的游戏 SKU。
   • 将 {INTL_UBI_WEB_AUTH_URL} 替换为 Ubisoft 提供的登录页面 URL。

2. 设置钥匙串共享。
   Ubisoft SDK 要求用户为 iOS 应用程序开启钥匙串共享功能，并设置一个名为 com.ubisoft.data 的钥匙串组。具体配置步骤如下：

   • 点击 Target，选择 Signing & Capabilities。

   • 点击 Keychain Sharing。如果 Keychain Sharing 未启用，请启用它。

   • 点击加号 (+) 并添加名为 com.ubisoft.data 的钥匙串组。

步骤2：添加 Ubisoft 登录

SDK 会拉起 WebView 并进入 Ubisoft 登录页面，用户在浏览器上登录 Ubisoft 账号之后，返回游戏继续 Ubisoft SDK 的登录操作。

1. 注册登录相关回调。

   Unity

   不适用。

   Unreal Engine

   C++ Event Handling (above v1.15)

   //configure callback
   FINTLAuthEvent authEvent;
   authEvent.AddUObject(this, &OnAuthResult_Implementation);
   UINTLSDKAPI::SetAuthResultObserver(authEvent);
   // Remove callbacks
   UINTLSDKAPI::GetAuthResultObserver().Clear();

   void OnAuthResult_Implementation(FINTLAuthResult ret)
   { 
       UE_LOG(LogTemp, Warning, TEXT("MethodID: %d"), ret.MethodId);
   }

   Unreal Event Handling

   void OnAuthResult_Implementation(FINTLAuthResult ret)
   { 
       UE_LOG(LogTemp, Warning, TEXT("MethodID: %d"), ret.MethodId);
   }

2. 调用 AutoLogin 接口自动登录。

   当用户之前登录过，用户可以调用自动登录接口。如果 token 仍然在有效期内则登录成功，若 token 失效则会抛出错误，需要业务调用手动登录接口重新登录。

   Unity

   不适用。

   Unreal Engine

   UINTLSDKAPI::AutoLogin();

3. 在自动登录失败时调用 Login 接口使玩家手动登录。

   Unity

   不适用。

   Unreal Engine

   UINTLSDKAPI::Login(EINTLLoginChannel::kChannelUbisoft);
   // Ubisoft DNA 数据事件报告定义, 可以通过 UbDnaEvent 参数传递到 Ubisoft 渠道插件来完成 Ubisoft SDK 初始化。 JSON 样本：
   FString extraJson = "{\"UbDnaEvents\": \"events definition generated from Ubi Event SDK\"}";
   
   // 支持游客登录 Ubisoft 后，调用不同 extraJson 的登录 API 进行不同的登录。
   UINTLSDKAPI::Login(EINTLLoginChannel::kChannelUbisoft, "", extraJson);

   支持的 extraJson:

   • 正式账号登录：extraJson = "{\"ubiLoginType\" : \"ubiLoginTypeFormal\"}"
   • 正式账号绑定游客账号-当前：extraJson = "{\"ubiLoginType\" : \"ubiLoginTypeFormalBindGuest\", \"ubiLoginTypeFormalBindGuest\" : \"ubiLoginTypeFormalBindGuestCur\"}"
   • 正式账号绑定游客账号-新建：extraJson = "{\"ubiLoginType\" : \"ubiLoginTypeFormalBindGuest\", \"ubiLoginTypeFormalBindGuest\" : \"ubiLoginTypeFormalBindGuestNew\"}"
   • 游客账号登录：extraJson = "{\"ubiLoginType\" : \"ubiLoginTypeGuest\"}"
   • 游客账号绑定正式账号-绑定：extraJson = "{\"ubiLoginType\" : \"ubiLoginTypeGuestBindFormal\", \"ubiLoginTypeGuestBindFormal\" : \"ubiLoginTypeGuestBindFormalBind\"}"

   玩家使用 Ubisoft Connect 登录时，如果返回 -20000，表示该设备本地有游客账号，游戏客户端需弹窗让用户选择绑定当前的游客账号或绑定新建游客账号

   • 如果选择绑定当前游客账号，游戏需再次调用 Login ，并传入"Ubisoft 账号绑定现有的游客账号" 对应的 extraJson。
   • 如果选择绑定新建游客账号，游戏需再次调用 Login ，并传入"Ubisoft 账号绑定新建的游客账号" 对应的 extraJson。

   用户使用游客账号登录后，进入设置界面，点击Link按钮时，表示用户想绑定一个正式账号，此时游戏侧应调用 the extended APIs下方扩展接口项，此时 Player Network SDK 会调起 UbisoftWebAuth，用户通过输入正式账号名和密码登录，成功后，通过 UbiservicesSDK 请求 Ubiserver 判断该账号是否可以绑定。

   • 如果 ubiserver 返回 -10000，表示 Unisoft 账号可以绑定，用户继续进入绑定流程，游戏侧需调用 登录，传入 extraJson 的参数是 “游客账号绑定正式账号-绑定” 对应的字符串。
   • 如果 ubiserver 返回 -10001，表示 Unisoft 账号无法绑定。

4. 与游戏后台同步客户端身份验证状态，等待最终验证结果。

登录接口返回 AuthResult，channel_info 数据格式如下：

"channel_info":"
{
        \"expire_ts\":1651047328,
        \"is_refresh\":0,
        \"profile_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-f34e406412d6\",
        \"sesssion_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-d82d645f5df0\",
        \"ticket\":\"...\",
        \"user_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-F88B443D15D6\"
}",

登出

调用接口 Logout 登出当前渠道并且传递相关参数。

Unity

不适用。

Unreal Engine

UINTLSDKAPI::Logout();

步骤3：验收登录功能

在 Player Network SDK 日志中搜索关键字 "AuthResult" 确认渠道名称和 OpenID 是否正确返回。如果正确，则表明集成配置成功，登录功能已成功添加。

如果接入过程中遇到问题，请参见 常见问题。

扩展接口

扩展接口

游客账号绑定 Ubisoft 账号

Unity

不适用。

Unreal Engine

// 根据手动接入流程中的说明，通过 “guestBindFormalAccountLogin” 调用 ExtendInvoke 拉起 webAuth
UINTLSDKAPI::ExtendInvoke(EINTLLoginChannel::kChannelUbisoft, "guestBindFormalAccountLogin", "");

获取 Ubisoft DNA 事件上报 Facade

Unity

不适用。

Unreal Engine

// "unsigned int64" 字符串，您应该将其转换为 Facade 指针
FString facadePtr = UINTLSDKAPI::ExtendInvoke(EINTLLoginChannel::kChannelUbisoft, "getUbDnaFacade", "");

设置 Ubisoft DNA 未上报 session events

Unity

不适用。

Unreal Engine

FString paramsJson; // {"events": "events json string"}
UINTLSDKAPI::ExtendInvoke(EINTLLoginChannel::kChannelUbisoft, "setUbLastSessionEvents", paramsJson);

获取 Ubisoft 渠道的用户 ID

Unity

不适用。

Unreal Engine

FString ubiUserID = UINTLSDKAPI::ExtendInvoke(EINTLLoginChannel::kChannelUbisoft, "getUbUserId", "");

如果您在通过 Ubisoft 登录时遇到困难，请参见 Ubisoft 常见问题。