适用于基于Android操作系统的移动端且通过AppTouch分发的应用,需要基于OAuth 2.0协议标准接入华为帐号,并使用Carrier ID从AppTouch GRS服务器获取华为帐号服务器的域名。
Authorization Code模式基于OAuth 2.0协议标准,应用可以通过获取帐号用户的临时授权票据(Authorization Code),使用户通过帐号安全登录您的应用,首次登录时,要求用户同意授权,当身份验证信息到期时,只需要从服务器端通过刷新令牌刷新访问令牌,从而更快,更可靠,更方便。Authorization Code模式仅适用于有自己服务器的应用。
完整的AppTouch应用Authorization Code模式登录授权流程为:
图标资源获取请参见获取图标资源。
“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();
}
});
} “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后,应用需要发送给应用服务器
} “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());
}
}
} 该部分代码需要您根据应用设计自己开发。
根据获取服务器域名可以获取到对应的华为帐号服务器域名,其中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 | 用于获取用户信息的域名 |
获取到code后,调用服务器接口向华为帐号服务器请求获取Access Token、Refresh Token。接口详细信息请参见获取凭证Access Token,接口调用错误码信息请参见错误码。
code只能使用一次,并且只有5分钟有效期,如出现code过期或者已使用错误码,则需要重新获取code。
使用Access Token调用获取用户信息接口向华为帐号服务器获取用户信息(昵称、头像、邮箱等)。
Access Token过期处理:
由于Access Token的有效期(目前是60分钟)较短,当Access Token失效或者即将失效时(可通过NSP_STATUS错误码判断),可以使用Refresh Token(有效期180天)通过获取凭证Access Token接口华为帐号服务器请求获取新的Access Token。
RefreshToken 过期处理:
由于Refresh Token的有效期为180天,当Refresh Token 失效(可通过错误码判断)后,应用服务器需要通知客户端,重新调用Account SDK登录授权接口,请求用户重新授权。
应用调用signOut接口退出当前已登录的帐号,并通知HMS Core SDK清除本地当前已经登录的帐号信息。
“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() }
} “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方法,实现取消授权。
“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() }
} “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)
}
}