App Safer Open API 사용가이드

App Safer Open API 사용 가이드

App Safer 콘솔의 management 기능을 Open API로 사용 가능합니다.

• App Safer Open API는 별도의 구독신청 없이 사용 가능합니다.

App Safer 빌드 자동화 가이드

App Safer는 Open API를 사용한 빌드 자동화 스크립트를 제공합니다.
빌드 자동화를 적용하려면 아래의 순서대로 설정을 진행해 주십시오.

1. 앱 등록

App Safer의 보호설정을 편리하게 적용하기 위해 App Safer 콘솔을 통해 앱 등록을 해야합니다.

1. Console > App Safer > Management 메뉴에서 앱등록을 합니다.
2. App Safer 사용 가이드를 참고하여 설정을 진행해 주십시오.
3. 앱이 정상적으로 실행되는지 확인합니다.

2. 스크립트 다운로드

App Safer에서는 Open API를 통해 앱 등록 및 다운로드를 하는 스크립트를 제공합니다.
콘솔에 이미 등록한 앱이 있다면 해당 앱의 설정이 적용된 스크립트를 다운로드 할 수 있습니다.

1) 등록 설정 확인

아래 메뉴에서 등록시 작성한 설정들을 확인할 수 있습니다.

• Console > App Safer > Management > 앱 선택 > 등록 설정 보기 > 설정 버튼 클릭

2) 스크립트 다운로드

팝업 하단에 스크립트 다운로드 버튼을 클릭하면 선택한 앱의 설정이 적용된 API 요청 스크립트를 다운로드 할 수 있습니다.

3) Access Key, SecretKey 확인

API 요청은 Access Key와 Secret Key를 통해 권한 관리가 이루어지며 다음과 같은 방법으로 확인할 수 있습니다.

• 메인 계정
  포털 > 마이페이지 > 계정 > 인증키 관리
  

• 서브 계정
  서브 계정 생성 및 관리를 참조해 주십시오.

4) 스크립트 실행

스크립트가 정상적으로 실행되는지 확인합니다.

usage: appsafer.py [-h] --access-key ACCESS_KEY --secret-key SECRET_KEY
                       [--rule RULE]
                       package out

실행에 성공하면 다음과 같은 화면을 확인할 수 있습니다.

> 아래 순서에 맞춰 AppSafer RULE을 추가할 수 있습니다.
> 1. RULE 내용이 포함된 별도 파일을 생성합니다. ex) my_rule_file 파일 생성
> 2. 스크립트의 '--rule' 파라미터에 RULE 파일 경로를 추가합니다. ex) --rule ~/my_rule_file

3. 빌드 설정

앱 빌드 시 App Safer가 자동으로 적용되도록 설정하는 방법입니다.

1) 프로젝트에 스크립트 파일 추가

다운로드 받은 스크립트 파일을 프로젝트 내의 build.gradle과 동일한 경로에 위치시킵니다.

2) build.gradle 설정

build.gradle 파일에 아래의 코드를 추가하고 accessKey와 secretKey를 입력합니다.

• APK

 // * prepare for apk * /
applicationVariants.all { variant ->
    def accessKey = "{ACCESS_KEY}";
    def secretKey = "{SECRET_KEY}";
    
    def apkPath = variant.outputs.stream().map({i -> i.getOutputFile()}).findFirst().get().getAbsolutePath();
    variant.getPackageApplicationProvider().get().doLast() {
        exec {
            commandLine 'python', 'appsafer.py', apkPath, apkPath, "--access-key", accessKey, "--secret-key", secretKey
        }
    }
}

• App Bundle

// * prepare for bundle * /
applicationVariants.all { variant ->
    def accessKey = "{ACCESS_KEY}";
    def secretKey = "{SECRET_KEY}";
    
    def bundleTaskName = "package${variant.name.capitalize()}Bundle"
    def bundleTask = tasks.findByPath(bundleTaskName)

    def bundlePath = bundleTask.bundleFile.get().getAsFile().getAbsolutePath()
    bundleTask.doLast {
        exec {
                commandLine 'python', 'appsafer.py', bundlePath, bundlePath, "--access-key", accessKey, "--secret-key", secretKey
        }
    }
}

3) 확인

빌드 성공 시 outputs 파일에 자동으로 AppSafer가 적용된 앱이 생성되며, App Safer 콘솔에서도 새로 빌드한 앱이 등록되는 것을 확인할 수 있습니다.