SNS 로그인 | Appbox Android SDK 가이드

Android SDK 연동

SNS 로그인 개요

전제내용
필요 artifact제공자별 appbox-auth-* + 초기화 설정의 auth
전제 미충족 시콜백 error로 AppBoxAuthUnavailableException 또는 AppBoxAuthNotConfiguredException → 예외 카탈로그
웹 브릿지 대응application.googleSnsLogin, appleSnsLogin, kakaoSnsLogin, naverSnsLogin, snsLogout

제공자별 전제는 다음과 같습니다.

제공자artifact추가 전제
Googleappbox-auth-googleauth 설정의 해당 key
Appleappbox-auth-appleprovider별 key 없음. auth 설정만 전달하면 configured가 true가 됩니다 (다른 제공자보다 약한 신호)
Naverappbox-auth-naverauth 설정의 해당 key
Kakaoappbox-auth-kakaokey + kakao_scheme 문자열 리소스 + 카카오 Maven 저장소 → 1단계: 저장소 접근 설정

initialize에 auth 설정을 아예 넘기지 않으면 Apple을 포함한 모든 제공자의 configured가 false입니다. artifact만으로는 true가 되지 않습니다.

로그인 제공자 목록 조회

앱에 포함된 로그인 제공자와 각각의 설정 완료 여부를 조회합니다. 로그인 버튼 노출 여부는 이 함수의 configured로 판단합니다.

로그인 제공자 목록 조회

AppBox.getAuthProviderDescriptors()

Kotlin
1 AppBox.getAuthProviderDescriptors()
2 .filter { it.configured }
3 .forEach { descriptor ->
4 when (descriptor.identifier) {
5 "google" -> showGoogleButton()
6 "apple" -> showAppleButton()
7 "naver" -> showNaverButton()
8 "kakao" -> showKakaoButton()
9 }
10 }
1 for (AppBoxAuthProviderDescriptor descriptor : AppBox.getAuthProviderDescriptors()) {
2 if (!descriptor.getConfigured()) continue;
3 switch (descriptor.getIdentifier()) {
4 case "google": showGoogleButton(); break;
5 case "apple": showAppleButton(); break;
6 case "naver": showNaverButton(); break;
7 case "kakao": showKakaoButton(); break;
8 }
9 }

Request 항목 정의

Request 항목필수여부설명기본값
--별도 요청 항목 없음-


Response 항목 정의

Response 결과값
List<AppBoxAuthProviderDescriptor>제공자 목록. 동기 함수이며 즉시 반환됩니다
[].typeAuthProviderType. GOOGLE, APPLE, NAVER, KAKAO
[].identifier"google", "apple", "naver", "kakao"
[].configured로그인에 필요한 key와 설정이 갖춰졌는지 (true | false)


identifier 문자열로 제공자를 구분합니다. 목록의 순서나 열거형 순번을 사용하지 않습니다. 목록에 포함된다는 것은 artifact를 추가했다는 의미입니다(확인의 사다리 ① 층). configured는 key와 설정 완비(③ 층)를 뜻하며, provider SDK 초기화 성공까지 보장하지 않습니다. 실제 동작은 signIn 결과로 확인합니다.

로그인

지정한 제공자로 로그인합니다. 로그인 버튼의 클릭 처리에서 호출합니다.

로그인

AppBox.signIn(type, activity, callback)

Kotlin
1 AppBox.signIn(AuthProviderType.KAKAO, this) { user, error ->
2 when {
3 error is AuthCancelledException -> Unit // 정상 취소: 오류 화면을 띄우지 않습니다
4 error != null -> showLoginError(error)
5 user != null -> onSignedIn(user.uid)
6 }
7 }
1 AppBox.signIn(AuthProviderType.KAKAO, this, new AppBoxValueCallback<UserAuthData>() {
2 @Override
3 public void onComplete(UserAuthData user, Throwable error) {
4 if (error instanceof AuthCancelledException) return; // 정상 취소
5 if (error != null) {
6 showLoginError(error);
7 return;
8 }
9 if (user != null) onSignedIn(user.getUid());
10 }
11 });

Request 항목 정의

Request 항목필수여부설명기본값
type필수AuthProviderType. GOOGLE, APPLE, NAVER, KAKAO-
activity필수로그인 화면을 표시할 foreground Activity-
callback필수AppBoxValueCallback<UserAuthData>-


Response 항목 정의

Response 결과값
userUserAuthData. 실패 시 null
user.uid사용자 식별자
user.email, user.displayName, user.photoURL프로필 정보. 비어 있을 수 있습니다
user.tokenGoogle, Apple에서 제공
user.accessToken, user.refreshTokenKakao, Naver에서 제공
오류AuthCancelledException: 사용자가 로그인 화면을 닫음. 정상 취소이며 오류가 아닙니다
(제공자 오류): provider SDK가 전달한 실패. 미설정 제공자 호출 포함


token 값을 로그나 분석 도구에 남기지 않습니다. callback은 최대 한 번 호출됩니다.

웹 브릿지에서는 제공자별 application.{provider}SnsLogin입니다.

제공자 로그아웃

지정한 제공자에서 로그아웃합니다. 서비스 로그아웃 처리에서 제공자별 결과가 필요할 때 호출합니다.

제공자 로그아웃

AppBox.signOut(type, callback)

Kotlin
1 AppBox.signOut(AuthProviderType.KAKAO) { success, error ->
2 if (!success) Log.w("AppBox", error?.message ?: "로그아웃 실패")
3 }
1 AppBox.signOut(AuthProviderType.KAKAO, new AppBoxOperationCallback() {
2 @Override
3 public void onComplete(boolean success, Throwable error) {
4 if (!success) Log.w("AppBox", String.valueOf(error));
5 }
6 });

Request 항목 정의

Request 항목필수여부설명기본값
type필수로그아웃할 제공자-
callback필수AppBoxOperationCallback-


Response 항목 정의

Response 결과값
success로그아웃 처리 성공 여부 (true | false)


해당 제공자가 configured 상태여야 합니다. 설정하지 않은 제공자를 로그아웃하면 오류입니다.

웹 브릿지에서는 SNS 로그아웃의 application.snsLogout입니다.

모든 제공자 로그아웃

로그인된 모든 제공자에서 로그아웃합니다. 제공자를 구분할 필요 없는 일괄 로그아웃에 호출합니다.

모든 제공자 로그아웃

AppBox.signOutAll(callback)

Kotlin
1 AppBox.signOutAll { success, error ->
2 if (!success) Log.w("AppBox", error?.message ?: "전체 로그아웃 실패")
3 }
1 AppBox.signOutAll(new AppBoxOperationCallback() {
2 @Override
3 public void onComplete(boolean success, Throwable error) {
4 if (!success) Log.w("AppBox", String.valueOf(error));
5 }
6 });

Request 항목 정의

Request 항목필수여부설명기본값
callback필수AppBoxOperationCallback-


Response 항목 정의

Response 결과값
success전체 로그아웃 성공 여부 (true | false)


초기화된 제공자가 하나도 없으면 즉시 성공을 반환합니다. 판정 기준은 로그인 세션 보유 여부가 아니라 provider 초기화 여부이므로, 성공이 곧 실제 세션 해제를 뜻하지 않습니다. 반대로 로그인한 적이 없어도 초기화된 제공자가 있으면 그 제공자의 로그아웃이 실제로 호출되고 실패가 보고될 수 있습니다. 모든 제공자 처리가 끝난 뒤 첫 번째 오류만 보고합니다. 어느 제공자가 실패했는지 구분해야 하면 제공자 로그아웃을 각각 호출합니다.

웹 브릿지에서는 SNS 로그아웃의 application.snsLogout입니다.

www.naver.com
QR 코드를 촬영하면 입력하신 주소의
앱 예시 화면을 테스트할 수 있습니다.
* 스캔 후 바로 앱 다운로드 이동합니다.