Introduction
This page is an introduction to Klip and Klip Developer Guide.
Klip
Klip is a personal digital wallet that allows you to conveniently manage digital assets. Despite there being numerous blockchain wallets out there, most of them failed to gain traction due to poor user experience (UX). Klip, on the other hand, is integrated in the messaging app KakaoTalk, and offers a good, simple UX. It can also contribute to the growth of blockchain applications (BApps), acting as a window to diverse Klaytn-based BApps. For more information on Klip, download KakaoTalk and go into the More[…] tab on the menu. If you need any help with this document or Klip in general, please visit our Developer Forum.
BApp and Card
BApps (Blockchain Applications) and DApps (Decentralized Applications) are essentially similar, but while the latter tends to emphasize "decentralization", BApp is a broader term that encompasses more of the unique advantages that blockchains offer. Fore more details on BApps, please visit Klaytn BApp.
Digital assets on Klip are called Cards. Klip Partners can issue various assets (game items, discount coupons etc.) in the form of Cards and send them to Klip or BApp users. Users can use or send the Cards they received on Klip, located in the More[…] tab in the mobile app KakaoTalk. During this process, Klip Partners get a chance to expose their BApps to potential customer base and convert them into actual clients.
All cards are NFTs(Non-Fungible Tokens). In simple terms, NFTs are unique assets, and not "currencies"(like Bitcoin, Ether etc.). For example, a dollar bill can be replaced with any other dollar bill any day, which makes it fungible. But my artwork is not replaceable with my neighbor's artwork, and thus is non-fungible. This is because the value of each art piece is unique, which cannot be compared in a consistent, let alone objective way. To sum up, NFTs are digitized piece of a unique asset, such as collectibles, artwork, and personal items, created in the form of tokens on a blockchain. The NFT used for BApps is called Cards. Klip users can use and exchange them on Klip. If you need help with this document or Klip in general, please visit our Developer Forum.
Klip API
Klip API allows you to send KLAY or FTs (Fungible Tokens), mint, retrieve, send, and burn NFTs on Klip from external services. It consists of Card Minting API and App2App API.
Card Minting API
Card Minting API allows registered Partners to mint, retrieve, send, and burn Cards. Using this simple API, you can build BApps that utilize Cards without having to deploy or manage complex smart contracts yourself. The steps for using Card Minting API are as follows:
Apply to become a Klip Partners.
After receiving approval from the Klip team, Sign In on the website.
After signing in, upload a cover image for your Card via Upload Image.
Start minting Cards using the uploaded image via Mint Card To User or Mint Card To Klip Member.
You can retrieve Card information using Get Card Information By BApp, Get Card Information.
Send the minted Card to other users via Send Card To User or Send Card To Klip Member.
The API also allows you to conveniently manage accounts and Cards.
Sign in with Sign In.
Change password to your account with Change Password.
Change PIN with Change Pin.
Retrieve and Delete Cards using Delete Card.
Klip API allows you to send KLAY or FT (Fungible Tokens) from external services, or to mint, retrieve, send, burn NFTs on Klip. Klip API consists of Card Minting API and App2App API.
App2App API
App2App API allows BApp developers to authenticate Klip users as well as send tokens and Cards without a separate registration process. You can also make requests to Klip users to execute smart contracts that you wrote. In a mobile environment where KakaoTalk is installed, BApps will generate a deep link to request signature on Klip.
App2App API can be used to:
authenticate BApp user's Klip Wallet address
send KLAY, tokens through Klip
send and retrieve Cards through Klip
run smart contracts through Klip
The steps for using App2App API are as follows:
Select and install the suitable SDK for your BApp in the Download tab. Alternatively, you can use REST API.
Incorporate Klip user authentication or signature function into your BApp using the Prepare, Request and Result APIs. During the Prepare step, you will obtain the key required to use App2App API, and for the Request step, run Klip. Finally in the Result step, you can view the request results.
The Request step can be done using QR code on PC or in a remote mobile environment. See App2App REST API for more details.
If you need any help with this document or Klip in general, please visit our Developer Forum.
About This Document
Klip Developer Guide contains instructions for BApp developers or Partners to manage and send FTs, or to mint, send, and burn NFTs using various APIs.
| Page | Description |
|---|---|
Klip and Klip API. | |
Authentication, pagination, error code, and glossary. | |
Card Minting API and App2App API. | |
App2App API SDKs for JavaScript, Android, iOS. | |
Tutorials for Card Minting API and App2App API. | |
The change log of APIs |
This document contains some basic information on API and development, which is subject to change. Software built following the instructions stated here must undergo a final test with the appropriate operating systems.
If you need any help with this document or Klip in general, please visit our [Developer Forum](https://forum.klaytn.com/c/klip-api/28).
Last updated
