앱 기본 정보 설정 및 환경체크 | Appbox SDK

앱 기본 정보 및 환경체크

AppBox WebView 실행 여부

현재 웹페이지가 AppBox SDK가 포함된 앱 웹뷰에서 실행 중인지, 또는 사파리·크롬과 같은 일반 브라우저에서 실행 중인지 판별할 수 있는 기능입니다. 이 기능을 사용하면 실행 환경에 따라, 브라우저용 UI나 동작 방식으로 대체하는 등 상황에 맞는 분기 처리가 가능합니다.

AppBox WebView 실행 여부

AppboxSDK.application.isAppBoxSDK()

Javascript
1 // 앱박스 SDK내의 Webview에서 실행인지 여부
2 if ( AppboxSDK.application.isAppBoxSDK() ){
3 console.log( "앱박스 SDK 에서 실행" );
4 } else {
5 console.log( "앱박스 SDK가 아님,, 크롬이나 사파리 브라우져" );
6 };




AppBox Project Id 조회

SDK 초기화 시 설정된 AppBox project Id를 조회할 수 있습니다.
AppBox 웹 SDK auto-bootstrap 또는 웹에서 현재 project Id가 필요한 경우 사용합니다.

AppBox Project Id 가져오기

AppboxSDK.getAppId()

Javascript
1 // AppBox Project Id 가져오기
2 AppboxSDK.getAppId( (err, data) => {
3 if (err) {
4 console.error( "AppBox Project Id 조회 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "AppBox Project Id :", data.result );
7 }
8 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
data.result AppBox project Id. 예) "MBS-730918"
err.code 에러코드
err.message 에러 메시지

AppBox 관리 웹뷰와 고객사 관리 WKWebView attach 경로에서 사용할 수 있습니다.






AppBox Device User Id 조회

SDK가 생성하고 보관하는 AppBox device user id를 조회할 수 있습니다.
웹에서 현재 기기의 AppBox 식별자가 필요한 경우 사용합니다.

AppBox Device User Id 가져오기

AppboxSDK.getDeviceUserId()

Javascript
1 // AppBox Device User Id 가져오기
2 AppboxSDK.getDeviceUserId( (err, data) => {
3 if (err) {
4 console.error( "AppBox Devcie User Id 조회 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "AppBox Device User Id :", data.result );
7 }
8 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
data.result AppBox device user id. 예) "abc123"
err.code 에러코드
err.message 에러 메시지





AppBox Device Info 조회

AppBox device user id와 push token을 한 번에 조회할 수 있습니다.
웹에서 기기 식별자와 푸시 토큰을 함께 사용하는 경우 사용합니다.

AppBox Device Info 가져오기

AppboxSDK.getDeviceInfo()

Javascript
1 // AppBox Device Info 가져오기
2 AppboxSDK.getDeviceInfo( (err, data) => {
3 if (err) {
4 console.error( "AppBox Device Info 조회 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "AppBox Device User Id :", data.deviceUserId);
7 console.log( "AppBox Push Token :", data.pushToken);
8 }
9 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
data.deviceUserId AppBox device user id. 예) "abc123"
data.pushToken FCM push token. 토큰이 없거나 아직 발급되지 않은 경우 빈 문자열
err.code 에러코드
err.message 에러 메시지





앱 최초 실행 여부

사용자가 앱을 처음 설치하고 실행한 상태인지 확인할 수 있는 기능입니다.
이를 활용하면 온보딩 화면 노출, 초기 권한 요청, 기본 설정 안내 등 ‘첫 실행 전용 경험’을 구성할 수 있으며, 앱 사용 시작 단계에서 더 나은 사용자 흐름을 만들 수 있습니다.

앱 최초 실행 인지 확인

AppboxSDK.application.isFirstInstallLaunch()

Javascript
1 // 앱 설치후 처음 체크 인지 확인
2 AppboxSDK.application.isFirstInstallLaunch( (err, data) => {
3 if (data.result) {
4 console.log( "앱 설치후 처음 체크 실행입니다");
5 } else {
6 console.log( "앱 설치후 처음 체크 실행이 아닙니다.");
7 }
8 });




앱 실행 세션 최초 여부

앱을 완전히 종료한 뒤 첫 진입인지 확인하는 기능입니다.
이를 활용하면 앱 실행 시 초기 안내를 표시하거나, 세션을 초기화하거나, 재실행 시점에만 필요한 특정 동작을 실행하는 등 실행 흐름을 상황에 맞게 분기할 수 있습니다.

앱 실행 세션 최초 여부를 체크

AppboxSDK.application.isFirstSessionLaunch()

Javascript
1 // 앱 종료후 처음 체크
2 AppboxSDK.application.isFirstSessionLaunch( (err, data) => {
3 if (data.result) {
4 console.log( "앱 종료후 처음 체크 실행입니다");
5 } else {
6 console.log( "앱 종료후 처음 체크 실행이 아닙니다.");
7 }
8 });




앱 이름

현재 실행 중인 앱의 이름을 웹뷰에서 바로 조회할 수 있는 기능입니다.
이를 활용하면 앱 이름을 UI에 표시하거나, 서비스 환경에 따라 문구를 다르게 구성하는 등 브랜드에 맞춘 사용자 경험을 제공할 수 있습니다.

앱 이름 가져오기

AppboxSDK.application.getAppName()

Javascript
1 // 앱 이름 가져오기
2 AppboxSDK.application.getAppName( (err, data) => {
3 if (err) {
4 console.error( "앱 이름 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "앱 이름 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 앱 이름 (ex : 모두의 배달)





앱 버전

사용자가 설치한 앱의 버전 정보를 조회할 수 있습니다.
버전별로 기능을 분기하거나 업데이트 유도 팝업을 띄울 때 편리합니다.

앱 버전

AppboxSDK.application.getAppVersion()

Javascript
1 // 앱 버전 가져오기
2 AppboxSDK.application.getAppVersion( (err, data) => {
3 if (err) {
4 console.error( "앱 버전 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "앱 버전 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 앱 버전 (ex : 1.0.5)





OS 버전

사용자 디바이스의 운영체제 버전을 확인할 수 있습니다.
앱에서 실행 중인 OS 버전 정보를 웹에서 조회해야 할 때 사용합니다.

OS 버전 가져오기

AppboxSDK.application.getOSVersion()

Javascript
1 // OS 버전 가져오기
2 AppboxSDK.application.getOSVersion( (err, data) => {
3 if (err) {
4 console.error( "OS 버전 조회 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "OS 버전 :", data.result );
7 }
8 });

Request 항목 정의

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


Response 항목 정의

Response 결과값
data.result OS 버전 문자열. 예) "18.3.1"
err.code 에러코드
err.message 에러 메시지






패키지 명

앱의 고유 패키지 명(번들 ID)을 가져오는 기능입니다.
환경 식별이나 특정 플랫폼 설정 검증이 필요할 때 활용할 수 있습니다.

패키지 명 가져오기

AppboxSDK.application.getPackageName()

Javascript
1 // 패키지 명 가져오기
2 AppboxSDK.application.getPackageName( (err, data) => {
3 if (err) {
4 console.error( "패키지 명 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "패키지 명 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 패키지 명 (ex : com.comapanyname.service)





SDK 버전

웹뷰가 사용 중인 앱박스 SDK 버전을 확인할 수 있습니다.
SDK 기능 호환 체크나 버전별 동작 분기 로직에서 유용합니다.

SDK 버전 가져오기

AppboxSDK.application.getSDKVersion()

Javascript
1 // 앱박스 SDK 버전 가져오기
2 AppboxSDK.application.getSDKVersion( (err, data) => {
3 if (err) {
4 console.error( "앱박스 SDK 버전 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "SDK 버전 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result SDK 버전 (ex : 2.0.3)





사용 언어

단말기 또는 앱에서 설정된 언어 정보를 가져옵니다.
다국어 웹앱을 만들 때 언어별 페이지 구성이나 번역 처리에 바로 사용해보세요.

사용 언어 가져오기

AppboxSDK.application.getCurrentLanguage()

Javascript
1 // 사용 언어
2 AppboxSDK.application.getCurrentLanguage( (err, data) => {
3 if (err) {
4 console.error( "사용 언어 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "사용 언어 : ", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 사용 언어 (ex : ko-KR)





배터리 상태

단말기의 배터리 잔량이나 충전 여부 등을 조회할 수 있습니다.
배터리 소모가 큰 기능 실행 전 안내를 주거나, 저전력 모드에 맞춘 처리가 가능합니다.

배터리 잔량 가져오기

AppboxSDK.application.getBatteryLevel()

Javascript
1 // 휴대폰 배터리 잔량 가져오기
2 AppboxSDK.application.getBatteryLevel( (err, data) => {
3 if (err) {
4 console.error( "배터리 잔량 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "배터리 잔량(%) : ", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 배터리 잔량 (ex : 75)





디바이스 모델

사용자가 어떤 기기(모델명)를 쓰고 있는지 확인할 수 있습니다.
특정 모델에서만 발생하는 이슈 대응이나, 기기별 UI 최적화 등에 활용할 수 있습니다.

디바이스 모델 가져오기

AppboxSDK.application.getDeviceModel()

Javascript
1 // 디바이스 모델 가져오기
2 AppboxSDK.application.getDeviceModel( (err, data) => {
3 if (err) {
4 console.error( "디바이스 모델 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "디바이스 모델 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 디바이스 모델 (ex : iPhone 15)





아이폰 여부

현재 기기가 iPhone인지 여부를 바로 판단할 수 있습니다.
iOS 전용 기능 분기나 스타일 조정이 필요할 때 손쉽게 체크할 수 있습니다.

아이폰 인지 여부를 체크

AppboxSDK.application.isIOS(...)

Javascript
1 // 아이폰 인지 여부를 체크
2 AppboxSDK.application.isIOS( (err, data) => {
3 if (data.result) {
4 console.log( "아이폰 입니다." );
5 } else {
6 console.log( "아이폰이 아닙니다." );
7 }
8 });




안드로이드 여부

현재의 기기가 Android인지 확인할 수 있는 기능입니다.
플랫폼별로 동작이 다른 로직을 짜거나, Android 전용 기능을 호출해야 할 때 사용하세요.

안드로이드 인지 여부를 체크

AppboxSDK.application.isAndroid(...)

Javascript
1 // 안드로이드 폰 인지 여부를 체크
2 AppboxSDK.application.isAndroid( (err, data) => {
3 if (data.result) {
4 console.log( "안드로이드 폰 입니다." );
5 } else {
6 console.log( "안드로이드 폰이 아닙니다." );
7 }
8 });




디바이스 타입 (Android, iOS)

단말기의 OS 타입을 문자열 형태로 직접 받아볼 수 있습니다.
플랫폼별 UI/기능 제어가 더 간단해지는 장점이 있습니다.

디바이스 타입 (Android, iOS)

AppboxSDK.application.getType()

Javascript
1 // 디바이스 타입 가져오기 (Android 또는 iOS)
2 AppboxSDK.application.getType( (err, data) => {
3 if (err) {
4 console.error( "디바이스 타입 가져오기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "디바이스 타입 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 디바이스 타입 (ex : Android )





클립보드 저장

웹뷰에서 전달한 텍스트를 기기의 클립보드에 바로 복사할 수 있습니다.
공유 코드, 쿠폰, 주소 복사 등 사용자 편의 기능에 아주 유용합니다.

클립보드에 저장하기

AppboxSDK.application.setClipBoard()

Javascript
1 // 클립보드에 저장하기
2 const text = "클립보드 저장 할 텍스트입니다.";
2 AppboxSDK.application.setClipBoard( { message : text }, (err, data) => {
3 if (err) {
4 console.error( "클립보드에 저장하기 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "클립보드에 저장하기 OK:", data.result );
7 }
8 });

Request 항목 정의

Request 항목 필수여부 설명 기본값
message 필수 클립보드에 저장할 내용


Response 항목 정의

Response 결과값
data.result 성공 여부 (true | false)





클립보드 가져오기

기기 클립보드에 저장된 문자열을 웹뷰로 가져오는 기능입니다.
사용자가 복사해둔 내용을 자동 입력하거나 특별한 입력 흐름을 구성할 때 활용할 수 있습니다.

클립보드 가져오기

AppboxSDK.application.getClipBoard()

Javascript
1 // 클립보드에 저장된 값 가져오기
2 AppboxSDK.application.getClipBoard( (err, data) => {
3 if (err) {
4 console.error( "클립보드 가져오기 실패 :", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "클립보드 저장된 값 :", data.result );
7 }
8 });

Response 항목 정의

Response 결과값
data.result 클립보드에 저장되어 있는 값





앱 내 데이터 저장

웹뷰에서 네이티브 영역에 데이터를 저장할 수 있는 기능입니다.
앱을 재실행하거나 웹뷰가 새로 로딩되더라도, 저장된 데이터는 유지되어 지속적으로 활용할 수 있습니다.

앱 내에 데이터를 저장

AppboxSDK.storage.set(...)

Javascript
1 // 앱(Native) 내에 데이터 저장
2 AppboxSDK.storage.set(
3 {
4 key: "nickName",
5 value: "교양있는 고양이"
6 }, (err, data) => {
7 if (err) {
8 console.error( "앱 내 데이터 저장 실패:", "code:", err.code, "message:", err.message );
9 } else {
10 console.log( "앱 내 데이터 저장 성공:", data.result );
11 }
12 });

Request 항목 정의

Request 항목 필수여부 설명 기본값
key 필수 저장할 데이터의 키값 (예: nickName)
value 필수 저장 할 데이터 (예: 교양있는 고양이)


Response 항목 정의

Response 결과값
data.result 성공 여부 (true | false)

앱 내에 저장되는 값은 암호화 처리되어, 디버깅·탈옥·루팅 환경에서도 직접적인 노출을 방어하여 보안성이 안전합니다.






앱 내 데이터 가져오기

웹뷰에서 네이티브 영역에 저장된 데이터를 다시 불러올 수 있는 기능입니다.
앱을 재실행하거나 웹뷰가 새로 로딩되더라도, 이전에 저장해둔 데이터를 호출해 동일한 환경을 유지할 수 있습니다.

앱 내에 데이터를 가져오기

AppboxSDK.storage.get(...)

Javascript
1 // 앱 내 저장해 놓은 데이터를 가져오기
2 const keyToGet = "nickName";
3 AppboxSDK.storage.get( { key : keyToGet }, (err, data) => {
4 if (err) {
5 console.error( "앱 데이터 가져오기 실패:", "code:", err.code, "message:", err.message );
6 } else {
7 console.log( "앱 데이터 가져오기 OK:", data.result );
8 });

Request 항목 정의

Request 항목 필수여부 설명 기본값
key 필수 가져올 데이터의 키값 (예: nickName)


Response 항목 정의

Response 결과값
data.result 앱 내 저장된 데이터 (ex : 교양있는 고양이)

앱 내에 저장되는 값은 암호화 처리되어, 웹에서 사용시에만 복화화 사용되어 보안성에 안전합니다.







앱 내 데이터 삭제

네이티브 영역에 저장해둔 앱 내 데이터를 선택적으로 제거할 수 있습니다.
로그아웃 처리나 환경 초기화 등이 필요할 때 깔끔하게 적용할 수 있습니다.

앱에 저장된 데이터 삭제

AppboxSDK.storage.remove()

Javascript
1 // 앱에 저장된 데이터 삭제합니다.
2 const keyStr = "nickName"; // 삭제할 데이터 키값
2 AppboxSDK.storage.remove( { key : keyStr }, (err, data) => {
3 if (err) {
4 console.error( "앱에 저장된 데이터 삭제 실패:", "code:", err.code, "message:", err.message );
5 } else {
6 console.log( "앱에 데이터 삭제 OK :", data.result );
7 }
8 });

Request 항목 정의

Request 항목 필수여부 설명 기본값
key 필수 삭제할 데이터의 키값 (예: nickName)


Response 항목 정의

Response 결과값
data.result 성공 여부 (true | false)





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