Introduction

이 페이지는 Klip과 Klip 개발자 가이드를 소개합니다.

Kaia는 기존의 Klaytn과 Finschia 블록체인 네트워크가 통합되어 운영되는 블록체인의 새 이름입니다. 이에 따라 본 문서는 대부분 Klaytn을 Kaia로 / KLAY를 KAIA로 지칭하지만, 하위 호환성을 위해 기존 호출과 응답에서 사용되던 klaytn, KLAY 등의 키워드는 동일하게 유지되는 점 참고 부탁드립니다.

Klip

Klip은 사용자의 디지털 자산을 쉽고 편리하게 관리해 주는 개인 디지털 지갑 서비스입니다. 지금까지 다양한 블록체인 지갑이 있었지만, 어려운 사용자 경험으로 인해 제한적으로 활용되었습니다. Klip은 카카오 계정과 연동되어 메신저만큼 쉬운 사용자 경험을 제공합니다. 또한, Kaia 기반의 다양한 블록체인 서비스들을 소개하는 창구 기능을 하며 블록체인 서비스 확산에 기여합니다.

BApp과 카드

BApp(Blockchain Application)은 DApp(Decentralized Application)과 유사하지만, DApp과 달리 탈중앙화를 넘어 블록체인의 다른 많은 장점까지 흡수한 더 포괄적인 개념으로 사용된 용어입니다. DApp 개발에 관한 자세한 내용은 Kaia Docs를 확인하시기 바랍니다.

카드란 Klip에서 사용되는 디지털 자산으로, 일반적으로 NFT를 가리킵니다. Klip 파트너사는 자산(게임 아이템, 할인 쿠폰 등)을 카드 형태로 발행하고 Klip 사용자 또는 BApp 사용자에게 보낼 수 있습니다. 사용자는 카드를 받고 Klip 지갑에서 원하는 카드를 사용하거나 또 다른 사람에게 보낼 수 있습니다. 이 과정에서 Klip 파트너사는 자신의 BApp을 잠재 고객에게 알리고 이들을 구매 고객으로 전환할 수 있습니다.

모든 카드는 기본적으로 대체 불가능한 토큰(Non-Fungible Token)입니다. 대체 불가능한 토큰은 간단하게 말하면 "화폐"(비트코인, 이더리움 등)가 아닌 "고유한 자산"입니다. 5만원권 지폐 1장은 다른 5만원권 지폐 1장으로 완벽히 대체 가능합니다. 하지만, 내 예술 작품은 다른 이의 예술 작품으로 대체 불가능합니다. 다른 이의 명작이 주는 가치와 내 명작이 주는 가치가 서로 같지 않고 비교하기도 어렵기 때문입니다. 이렇게 수집품, 예술 작품, 개인용 물품 등 고유한 자산을 디지털화하여 블록체인상에 토큰 형태로 표현한 것이 바로 대체 불가 토큰입니다. 카드는 BApp에서 사용하는 대체 불가 토큰이며 Klip 사용자는 Klip에서 카드를 쓰고 교환합니다.

Klip API

Klip API는 외부 서비스에서 API를 통해 Klip에 있는 코인 및 대체 가능한 토큰(FT)을 전송하거나 Klip에서 카드(NFT)를 발행, 조회, 전송 또는 삭제하는 기능을 제공합니다. Klip API는 Klip Partners API와 App2App API로 구성됩니다. Klip은 Kaia 외에 Ethereum, Polygon 자산에 대해서도 동일한 기능을 제공합니다.

Klip Partners API

Klip Partners API는 서비스에 가입한 파트너사에서 직접 카드를 발행, 조회, 전송, 삭제하기 위한 API입니다. 복잡한 스마트 컨트랙트 배포나 관리 및 운영없이 간단한 API를 사용하여 카드를 활용하는 BApp을 개발할 수 있습니다. Klip Partners API를 사용하기 위한 절차는 아래와 같습니다.

Klip Partners 웹사이트는 허가된 사용자만 접근 가능하나, Klip Partners 서비스가 2024년 7월 31일자로 종료되어 현재는 신규 가입 신청을 받지 않고 있습니다. 아울러 기존 사용자 역시 2024년 8월 1일부터 Klip Partners API를 호출할 수 없습니다.

  1. Klip Partners에 가입 신청을 합니다.

  2. Klip 운영진과 별도 협의를 거쳐 가입 승인을 얻은 후 Sign In으로 사이트에 로그인합니다.

  3. 로그인 후, Upload Image로 카드 이미지로 쓸 이미지 파일을 업로드합니다.

  4. Mint Card To User 또는 Mint Card To Klip Member로 업로드한 이미지를 사용해 카드를 직접 발행합니다.

  5. Get Card Information By BApp, Get Card Information으로 발행한 카드 정보를 조회합니다.

  6. Send Card To User 또는 Send Card To Klip Member로 발행한 카드를 다른 사람에게 전송합니다.

또한 API를 통해서 계정 및 카드를 쉽게 관리할 수 있습니다.

App2App API

App2App API는 BApp 개발자가 별도 가입 절차없이 Klip 사용자를 인증하고 해당 사용자의 토큰 및 카드를 전송하기 위한 API입니다. 또한 직접 개발한 스마트 컨트랙트 실행을 Klip 사용자에게 요청할 수 있습니다. 기본적으로 Klip 앱이 설치된 모바일 환경에서 BApp이 Deep Link를 통해 Klip에 서명을 요청하는 방식으로 동작합니다.

App2App API는 아래와 같은 상황에서 활용할 수 있습니다.

  • BApp 사용자의 Klip 지갑 주소 인증

  • Klip을 통한 KAIA, 토큰 전송

  • Klip을 통한 카드 조회 및 전송

  • Klip을 통한 Smart Contract 실행

App2App API를 사용하기 위한 절차는 아래와 같습니다.

  • 다운로드 탭에서 BApp 개발환경에 맞는 SDK를 다운로드 받아 설치합니다. 또는 REST API를 이용할 수도 있습니다.

  • Prepare, Request 및 Result API를 이용하여 Klip 사용자 인증 또는 서명 기능을 BApp에 구현합니다. Prepare 스텝에서 App2App API 요청을 위한 key를 발급받고, Request 스텝에서 Klip을 실행합니다. 마지막 Result 스텝에서 요청에 대한 결과를 확인할 수 있습니다.

  • 참고로 PC 또는 물리적으로 떨어진 모바일 환경에서는 QR code를 이용하여 Request 스텝을 처리할 수 있습니다. 자세한 내용은 App2App REST API 탭을 참조하십시오.

이 문서에 관하여

Klip 개발자 가이드는 BApp 개발자 또는 파트너사가 Klip에서 제공하는 다양한 API를 활용하여 토큰(FT)을 조회하고 전송하거나 카드(NFT)를 발행, 조회, 전송 또는 삭제하도록 안내하는 문서입니다.

페이지설명

Introduction

Klip과 Klip API를 소개합니다.

Basics

인증, 페이지네이션, 에러코드, 용어를 소개합니다.

REST API

Klip Partners API와 App2App API를 소개합니다.

App2App SDK

App2App API를 Javascript, Android, iOS 환경에서 제공하는 SDK를 소개합니다.

Tutorial

Klip Partners API와 App2App API 튜토리얼을 소개합니다.

Change Log

API 변경 이력을 소개합니다.

이 문서는 API 또는 개발에 관한 기본적인 정보를 포함하고 있습니다. 이 정보는 변경될 수 있으며 이 문서를 따라 구현한 소프트웨어는 반드시 최종적으로 운영 체제 소프트웨어와 함께 테스트되어야 합니다.

이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

NextBasics

Last updated