目录

AppTouch应用Authorization Code模式接入华为帐号(OAuth 2.0)

场景介绍

适用于基于Android操作系统的移动端且通过AppTouch分发的应用,需要基于OAuth 2.0协议标准接入华为帐号,并使用Carrier ID从AppTouch GRS服务器获取华为帐号服务器的域名。

Authorization Code模式基于OAuth 2.0协议标准,应用可以通过获取帐号用户的临时授权票据(Authorization Code),使用户通过帐号安全登录您的应用,首次登录时,要求用户同意授权,当身份验证信息到期时,只需要从服务器端通过刷新令牌刷新访问令牌,从而更快,更可靠,更方便。Authorization Code模式仅适用于有自己服务器的应用。

完整的AppTouch应用Authorization Code模式登录授权流程为:

  1. 移动端应用调用Account SDK的登录接口,获取到授权码Authorization Code(有效期5分钟,且只能使用一次)和对应运营商的Carrier ID。
  2. 移动端应用将Authorization Code和Carrier ID通过自定义接口发送给应用服务器。
  3. 应用服务器将Carrier ID发送给AppTouch GRS服务器,获取华为帐号服务器的域名。
  4. 应用服务器通过调用华为帐号服务器的获取凭证接口,换取Refresh Token和Access Token。
  5. 应用服务器通过使用Access Token参数,调用华为帐号服务器的获取用户信息接口,获取用户信息。

开发前提

  1. 请确认您已完成开发准备。
  2. 请确认您的应用有自己的服务器。
  3. 在进行开发之前,您可以下载移动与智慧屏应用Authorization Code模式接入华为帐号Demo进行快速体验。

帐号登录授权

[h2]登录流程

[h2]客户端开发

  1. 集成华为登录按钮,展示登录方式图标。

    图标资源获取请参见获取图标资源。

  2. 拉起登录授权页面请求用户授权。

    将silentSignInByHwId()绑定到登录按钮R.id.HuaweiIdAuthButton的onClick响应事件中,实现华为帐号登录功能。当用户点击登录按钮时,会启动登录视图。
    “Java”
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            // activity_main为自定义布局文件名称
            setContentView(R.layout.activity_main);
            findViewById(R.id.HuaweiIdAuthButton).setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    silentSignInByHwId();
                }
            });
        }
    在silentSignInByHwId方法中,构造了请求参数AccountAuthParams和华为帐号登录授权服务AccountAuthService,通过调用静默登录接口silentSignIn进行静默登录,如果静默登录成功,直接获取华为帐号code信息;如果静默登录失败,再调用前台登录授权接口getSignInIntent,显式拉起登录授权视图进行登录。
    “Java”
        // 华为帐号登录授权服务,提供静默登录接口silentSignIn,获取前台登录视图getSignInIntent,登出signOut等接口
        private AccountAuthService mAuthService;
     
        // 华为帐号登录授权参数
        private AccountAuthParams mAuthParam;
     
        // 用户自定义signInIntent请求码
        private static final int REQUEST_CODE_SIGN_IN = 1000;
     
        // 用户自定义日志标记
        private static final String TAG = "Account";
     
        /**
         * 静默登录,如果设备上的华为帐号系统已经登录,并且用户已经授权过,无需再拉起登录页面和授权页面,
         * 将直接静默登录成功,在成功监听器中,返回帐号信息;
         * 如果华为帐号系统帐号未登录或者用户没有授权,静默登录会失败,需要显式拉起前台登录授权视图。
         */
        private void silentSignInByHwId() {
            // 1、配置登录请求参数AccountAuthParams,包括请求用户的id(openid、unionid)、email、profile(昵称、头像)等;
            // 2、DEFAULT_AUTH_REQUEST_PARAM默认包含了id和profile(昵称、头像)的请求;
            // 3、如需要再获取用户邮箱,需要setEmail();
            // 4、通过setAuthorizationCode()来选择使用code模式,最终所有请求的用户信息都可以调服务器的接口获取;
            // 5、通过setCarrierId()来请求获取carrierId,在开发者调用silentSignIn或getSignInIntent接口时会返回carrierId。
            mAuthParam = new AccountAuthParamsHelper(AccountAuthParams.DEFAULT_AUTH_REQUEST_PARAM)
                    .setEmail()
                    .setAuthorizationCode()
                    .setCarrierId()
                    .createParams();
     
            // 使用请求参数构造华为帐号登录授权服务AccountAuthService
            mAuthService = AccountAuthManager.getService(this, mAuthParam);
     
            // 使用静默登录进行华为帐号登录
            Task<AuthAccount> task = mAuthService.silentSignIn();
            task.addOnSuccessListener(new OnSuccessListener<AuthAccount>() {
                @Override
                public void onSuccess(AuthAccount authAccount) {
                    // 静默登录成功,处理返回的帐号对象AuthAccount,获取帐号信息并处理
                    dealWithResultOfSignIn(authAccount);
                }
            });
            task.addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(Exception e) {
                    // 静默登录失败,使用getSignInIntent()方法进行前台显式登录
                    if (e instanceof ApiException) {
                        ApiException apiException = (ApiException) e;
                         Intent signInIntent = mAuthService.getSignInIntent();
                        startActivityForResult(signInIntent, REQUEST_CODE_SIGN_IN);
                    }
                }
            });
        }
     
        /**
         * 处理返回的AuthAccount,获取帐号信息
         *
         * @param authAccount AuthAccount对象,用于记录帐号信息
         */
        private void dealWithResultOfSignIn(AuthAccount authAccount) {
            Log.i(TAG,"code:"+authAccount.getAuthorizationCode());
            Log.i(TAG,"code:"+authAccount.getCarrierId());
            //TODO 获取到Code信息和CarrierId后,应用需要发送给应用服务器
        }

  3. getSignInIntent前台登录授权接口登录成功后,处理登录授权结果,获取code,并发送给服务端

    “Java”
        @Override
        protected void onActivityResult(int requestCode, int resultCode, Intent data) {
            super.onActivityResult(requestCode, resultCode, data);
            if (requestCode == REQUEST_CODE_SIGN_IN) {
                Log.i(TAG, "onActivitResult of sigInInIntent, request code: " + REQUEST_CODE_SIGN_IN);
                Task<AuthAccount> authAccountTask = AccountAuthManager.parseAuthResultFromIntent(data);
                if (authAccountTask.isSuccessful()) {
                    // 登录成功,获取到登录帐号信息对象authAccount
                    AuthAccount authAccount = authAccountTask.getResult();
                    dealWithResultOfSignIn(authAccount);
                    Log.i(TAG, "onActivitResult of sigInInIntent, request code: " + REQUEST_CODE_SIGN_IN);
                } else {
                    // 登录失败,status code标识了失败的原因,请参考API中的错误码参考了解详细错误原因
                    Log.e(TAG, "sign in failed : " +((ApiException)authAccountTask.getException()).getStatusCode());
                }
            }
        }

[h2]服务端开发

  1. 接收客户端发送过来的Code和Carrier ID

    该部分代码需要您根据应用设计自己开发。

  2. 使用Carrier ID和Service Name获取对应的华为帐号服务器域名

    根据获取服务器域名可以获取到对应的华为帐号服务器域名,其中Carrier ID参数可以从步骤1获取,services参数中携带的Service Name由您按照实际需要从下表中获取。如下表所示,AppTouch GRS服务器根据请求体中的Service Name返回对应的华为帐号服务器域名信息,域名信息由key-value键值对组成。

    Service Name

    域名的key

    域名的value

    oauth.apptouch

    token

    用于获取凭证Access Token的域名

    tokeninfo

    用于解析凭证Access Token的域名

    account.apptouch

    userinfo

    用于获取用户信息的域名

  3. 用code换取Access Token和Refresh Token

    获取到code后,调用服务器接口向华为帐号服务器请求获取Access Token、Refresh Token。接口详细信息请参见获取凭证Access Token,接口调用错误码信息请参见错误码。

    code只能使用一次,并且只有5分钟有效期,如出现code过期或者已使用错误码,则需要重新获取code。

  1. 使用Access Token获取用户信息

    使用Access Token调用获取用户信息接口向华为帐号服务器获取用户信息(昵称、头像、邮箱等)。

    Access Token过期处理:

    由于Access Token的有效期(目前是60分钟)较短,当Access Token失效或者即将失效时(可通过NSP_STATUS错误码判断),可以使用Refresh Token(有效期180天)通过获取凭证Access Token接口华为帐号服务器请求获取新的Access Token。

    1. 当Access Token失效时,若您不使用Refresh Token向帐号服务器请求获取新的Access Token,帐号的授权信息将会失效,导致使用Access Token的功能都会失败。
    2. 当Access Token非正常失效(如修改密码,退出帐号,删除设备)时,业务可通过调用退出帐号接口后再调用静默登录接口获取新的Access Token。

    RefreshToken 过期处理:

    由于Refresh Token的有效期为180天,当Refresh Token 失效(可通过错误码判断)后,应用服务器需要通知客户端,重新调用Account SDK登录授权接口,请求用户重新授权。

独立授权(可选)

该步骤根据您的需要进行选择性接入。详情请参见独立授权(可选)。

帐号退出

应用调用signOut接口退出当前已登录的帐号,并通知HMS Core SDK清除本地当前已经登录的帐号信息。

  1. 将signOut方法绑定到退出按钮HuaweiIdSignOutButton的onClick响应事件中,实现华为帐号退出功能。

    “Java”
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        findViewById(R.id.HuaweiIdSignOutButton).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                signOut();
            }
        });
    }
    
    “Kotlin”
    override fun onCreate(savedInstanceState: Bundle?) {
        findViewById<View>(R.id.HuaweiIdSignOutButton).setOnClickListener { signOut() }
    }

  1. 调用AccountAuthService类对象的signOut方法,实现华为帐号退出。

    “Java”
    private void signOut() {
        Task<Void> signOutTask = mAuthService.signOut();
        signOutTask.addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                Log.i(TAG, "signOut Success");
            }
        }).addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(Exception e) {
                Log.i(TAG, "signOut fail");
            }
        });
    }
    
    “Kotlin”
    private fun signOut() {
        val signOutTask = mAuthService!!.signOut()
        signOutTask.addOnSuccessListener {
            Log.i(TAG, "signOut Success")
        }.addOnFailureListener {
            Log.i(TAG, "signOut fail")
        }
    }

取消授权

为了提升应用隐私安全,应用可以提供入口,供用户取消对应用的授权。

取消授权接口通过调用AccountAuthService类对象的cancelAuthorization方法,实现取消授权。

  1. 将cancelAuthorization方法绑定到取消授权按钮HuaweiIdCancelAuthButton的onClick响应事件中,实现华为帐号取消授权功能。

    “Java”
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        findViewById(R.id.HuaweiIdCancelAuthButton).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                cancelAuthorization();
            }
        });
    }
    
    “Kotlin”
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        findViewById<View>(R.id.HuaweiIdCancelAuthButton).setOnClickListener { cancelAuthorization() }
    }

  1. 调用AccountAuthService类对象的cancelAuthorization方法,实现华为帐号取消授权功能。

    “Java”
    private void cancelAuthorization() {
        Task<Void> task = mAuthService.cancelAuthorization();
        task.addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                Log.i(TAG, "cancelAuthorization success");
            }
        });
        task.addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(Exception e) {
                Log.i(TAG, "cancelAuthorization failure:" + e.getClass().getSimpleName());
            }
        });
    }
    
    “Kotlin”
    private fun cancelAuthorization() {
        val task = mAuthService!!.cancelAuthorization()
        task.addOnSuccessListener {
            Log.i(TAG, "cancelAuthorization success")
        }
        task.addOnFailureListener { e ->
            Log.i(TAG, "cancelAuthorization failure:" + e.javaClass.simpleName)
        }
    }