Android SDK
이 페이지에서는 BApp에서 Klip을 활용하기 위한 App2App Android SDK를 소개합니다.
Last updated
이 페이지에서는 BApp에서 Klip을 활용하기 위한 App2App Android SDK를 소개합니다.
Last updated
API 16: Android 4.1(Jelly Bean) 이상
Java 11 이상
Android Studio 3.0.0 이상
Android Permission : Internet Permission
Klip Android SDK는 별도의 가입 절차가 필요하지 않습니다. HTTP 통신이 가능한 어느 환경에서도 동작합니다. 다만, 기본적으로 Klip 앱이 설치된 환경에서 호출해야 합니다. Klip 앱을 실행하여 Klip 사용자의 승인을 받아야 하기 때문입니다.
Klip Android SDK Sample 앱의 실행 가이드는 프로젝트에 포함되어 있는 README.md
에 소개되어 있습니다.
페이지에서 Klip Android SDK를 다운받습니다.
다운받은 Klip SDK 프로젝트의 위치에서 Terminal을 실행
./gradlew :sdk:build
명령을 실행하여 Klip SDK 프로젝트를 빌드 (빌드가 완료되면 <Klip SDK 프로젝트>/sdk/build/outputs/aar/위치에 결과물인 AAR 파일이 생성됨)
개발 프로젝트에 libs 디렉토리를 생성
빌드된 AAR 파일을 개발 프로젝트의 libs 디렉토리로 복사
개발 프로젝트의 build.gradle
에 디렉토리 참조 및 디펜던시 설정을 추가
개발 중인 프로젝트를 Android Studio로 실행
Android Studio > File > New > Import Module을 클릭
Source Directory에 다운받은 Klip SDK 프로젝트의 sdk 디렉토리를 선택, 클릭한 후 Next를 클릭
Klip SDK 프로젝트의 gradle.properties
내용들을 개발 프로젝트로 복사
개발 프로젝트의 build.gradle
에 디펜던시 설정을 추가
Klip SDK 소스가 개발 프로젝트에 복사되고 라이브러리 코드를 직접 수정할 수 있습니다. 만약, 단일 버전의 라이브러리 코드를 유지하려는 경우에는 이 방법이 적절하지 않을 수 있습니다. 이 경우, 방법 1에서 안내한 내용에 따라 컴파일된 AAR 파일을 추가합니다.
Klip SDK를 통해 HTTP 통신 사용을 허용하기 위해, 앱에 인터넷 사용 권한을 설정해야 합니다. AndroidManifest.xml 파일에 다음과 같이 android.permission.INTERNET
권한을 추가합니다.
App2App API 요청은 크게 prepare
, request
, getResult
의 순서로 진행이 됩니다.
prepare
는 어떠한 요청을 할지 요청을 정의하는 단계로 총 5가지 종류의 요청이 존재
request
는 함수 호출을 통해 Klip으로 화면이 전환되어 실제 서명 프로세스를 진행
getResult
는 함수 호출을 통해 결과값을 받고 확인
추가적으로 getCardList는 BApp 개발의 편의를 위해 Klip 사용자의 NFT 목록을 받아올 수 있도록 제공되는 함수입니다.
Klip SDK를 사용하기 위한 인스턴스를 생성합니다.
Parameters
context
Context
애플리케이션 컨텍스트
Return Value
Klip
Klip 인스턴스
Example
App2App API 요청 처리를 준비하고 request key를 발급합니다.
Request 값에 사용할 객체
Klip 연결 타입(=인증)의 경우 AuthRequest
KAIA(=KLAY) 전송 타입의 경우 KlayTxRequest
Token 전송 타입의 경우 TokenTxRequest
Card 전송 타입의 경우 CardTxRequest
Contract 실행 타입의 경우 ContractTxRequest
Sign Message 요청 타입의 경우 SignMessageRequest
- 이 경우 Klaytn 표준에 따라 "\x19Klaytn Signed Message:\n" + len(message)
의 접두사를 붙여 서명합니다.
Parameters
request
KlipRequest
요청 타입에 따른 요청정보
bappInfo
BAppInfo
요청 앱 정보
callback
KlipCallback<KlipResponse>
요청 응답 결과를 받을 콜백함수입니다. 처리가 완료되면, 완료결과인 KlipResponse
를 전송받고, 처리가 실패되면, 실패결과인KlipErrorResponse
를 전송받습니다.
Throws
KlipRequestException
요청 예외 (ex, 필수 Parameter 미입력시 발생)
Klip 사용자에게 동의 요청시, request와 bappInfo에 입력된 정보가 출력됩니다. 응답 결과에 포함된 request key는 사용자에게 트랜잭션을 요청하기 위한 컨텍스트 키의 역할을 수행하며, 사용자 동의 요청 및 결과확인 API와 함께 사용됩니다.
Example 1. 사용자 정보 획득하기
Example 2. KAIA(=KLAY) 전송하기
Example 3. Token 전송하기
Example 4. Card 전송하기
Example 5. Contract 실행하기
Example 6. Sign Message 실행하기
Deep Link를 이용하여 Klip에 인증 또는 서명을 요청합니다. 실행 중인 스마트폰 기기에 Klip 앱이 설치되지 않았거나 자동 실행할 수 없는 경우 'Klip 소개 페이지(https://klipwallet.com)' 로 이동하여 사용자는 Klip 앱을 다운로드받을 수 있습니다. requestKey에는 prepare 단계에서 Klip 서버로부터 받은 요청 번호를 사용합니다.
Parameters
requestKey
String
요청 번호
Throws
KlipRequestException
요청 예외 (ex, 필수 Parameter 미입력시 발생)
Example
App2App API 요청에 대한 결과를 확인합니다. requestKey에는 prepare 및 request 단계에서 사용한 요청 번호를 사용합니다.
Parameters
requestKey
String
요청 번호
callback
KlipCallback<KlipResponse>
요청 응답 결과를 받을 콜백함수입니다. 처리가 완료되면, 완료결과인 KlipResponse
를 전송받고, 처리가 실패되면, 실패결과인KlipErrorResponse
를 전송받습니다.
Throws
KlipRequestException
요청 예외 (ex, 필수 Parameter 미입력시 발생)
Example
사용자의 모든 카드 중 특정 카드의 목록을 가져옵니다.
Parameters
cardAddress
String
조회할 카드 주소
userAddress
String
조회할 사용자 주소
cursor
String
(optional) 조회할 커서값입니다. 만약, 조회할 카드의 보유목록이 100개 이상이면, 다음 100개 정보를 받을 수 있습니다.
callback
KlipCallback<CardListResponse>
요청 응답 결과를 받을 콜백함수입니다. 처리가 완료되면, 카드목록인 CardListResponse
를 전송받고, 처리가 실패되면, 실패 결과인KlipErrorResponse
를 전송받습니다.
Throws
KlipRequestException
요청 예외 (ex, 필수 Parameter 미입력시 발생)
Example
에러코드는 KlipCallback
의 실패의 응답결과인 KlipErrorResponse
의 getErrorCode()
함수를 통해 확인할 수 있습니다.
-
-
500
10
Klip SDK에서 에러 발생 (ex, Http 연결 실패)
500
21
Klip SDK에서 에러 발생 (Klip REST API 미지원 에러코드)
500
22
Klip SDK에서 에러 발생 (Klip Protocol 에러)
App2App SDK Android v2.0.1 이하 버전을 사용하면서 Android 11을 타겟팅하는 앱(API 수준 30)을 개발하는 경우 Klip과 연동을 위해 패키지 쿼리를 추가해 상호작용을 설정해야 합니다. AndroidManifest.xml 파일에 다음과 같이 queries
요소를 추가하세요. (App2App SDK v2.1.0 이상을 사용하는 경우는 설정하지 않아도 됩니다.)
자세한 내용은 를 참고합니다.
이 문서 혹은 Klip에 관한 문의는 을 방문해 도움을 받으십시오.
PC 환경에서 QR code를 이용한 request 스텝 처리는 항목을 참조하십시오.
와 동일
이 문서 혹은 Klip에 관한 문의는 을 방문해 도움을 받으십시오.