Basics
This page introduces the basic knowledge required for using KAS Console and KAS API.
KAS Console & KAS API
For developing a blockchain application with KAS, you need to use KAS Console and KAS API together. To call KAS API, you first have to create an account pool on the KAS Console to store and manage Klaytn accounts for the API; and then have to create an API authentication key for calling the API.
A Klaytn transaction fee-payer account must be created on the KAS Console if the application uses the fee delegation method when sending transactions to the platform. Use the account address (EOA) as a parameter when calling the API. Similarly, create an operator account on the KAS Console if your application needs to send a transaction for anchoring service chain data to the main chain, and use the account address (EOA) when calling the API.
For inquires about this document or KAS, please visit Developer Forum.
KAS Account & Klaytn Account
KAS account is different from Klaytn account. Your KAS account serves you only for KAS itself and is used for set-ups for calling API, monitoring API usage (pay-per-use), and payments. On the other hand, Klaytn account is an account existing in Klaytn blockchain platform, and via this account you can send transactions to Klaytn or access its data. With KAS, you are guided to interact with Klaytn by creating Klaytn accounts, which are stored in account pool, through your KAS Account.
One KAS account can create one or more Klaytn account pools. One Klaytn account pool can contain one or more Klaytn accounts.
The major reason why you play with blockchain is either sending transactions to it or access data written on it. KAS is designed to offer services that make your tasks for these purposes much easier; everything you need is brought to you via simple API calls. KAS account is the subject who calls API, and if you provide the information about your Klaytn account in API request, you are able to send transactions to Klaytn or access its data via this Klaytn account. Account pool is offered to manage multiple Klaytn accounts and to give you convenience when choosing an account among many others on API calls.
For inquires about this document or KAS, please visit Developer Forum.
KAS Console
On the KAS Console, you can create and manage authentication keys needed for calling KAS APIs, and set the API calling privileges for the respective KAS accounts. You may also create and manage account pool for keeping Klaytn accounts in groups and a preset to track KLAY, FT (KIP-7, ERC-20), NFT (KIP-17, ERC-721) information and transaction history. Moreover, you can manage your KAS account information and register the token information in KAS to track transaction history of ERC-20/ERC-721 tokens you created.
Item | Description | Note |
Dashboard | Monitoring API usage of your KAS account | KAS Console's main page |
Security | Generating/managing API authentication key, Configuring API permission/role for KAS account | Credential menu, Permission menu |
Service | API details, Creating account pool and account, Creating preset | Klaytn Node menu, Token History menu, Wallet menu, Anchor menu |
My Page | Managing KAS account, Labeling ERC-20/ERC-721 tokens | My Info menu, Change Password menu, My ERC Token menu, Upgrade menu |
For inquires about this document or KAS, please visit Developer Forum.
KAS API
Mainly, you can perform two tasks with KAS API.
Send transactions to Klaytn
Get information and records of sending or receiving KIP-7, KIP-17, ERC-20, ERC-721 tokens
An API authentication key must be issued to use the KAS API, and the key needs to be fed to API request header. And, if you write KRN in the x-krn parameter of API request header, you can choose a specific Klaytn account from the account pool and use it on calling API. Pagination (cursor-based) may also be used to receive API response values.
You must be careful in protecting your API authentication key from others who are not authorized to see or use your key.
By making an account pool in KAS Console, you can group your Klaytn accounts by purpose.
The transaction fee-payer account can be used for sending transactions in KAS API, but users may also request for KAS to pay the transaction fees first and then pay later. The KAS API can also be utilized in other development environments with SDK.
Item | Description | Note |
Details about using API authentication key in API request header | Use basic authorization | |
Details about calling API and receiving results with pagination | Use query parameter | |
Introduction to KRN (KAS Resource Name) | Use KRN-base account pool | |
Transaction fee delegation in KAS | UserFeePayer, GlobalFeePayer | |
Installation and usage of KAS SDK | Caver-js, Caver-java |
For inquires about this document or KAS, please visit Developer Forum.
KAS Glossary
Terms | Description |
Klaytn | |
KLAY | Klaytn's main cryptocurrency, used for paying transaction fee in Klaytn |
FT | Fungible token, see KIP-7 |
NFT | Non-fungible token, see KIP-17 |
Wallet API | APIs for transaction, account key, and account management |
Resource | All resources used in KAS service, such as account and key |
KRN | Short for KAS Resource Name; KAS resource identifier |
Account | Klaytn account |
EOA | Externally Owned Account, see Klaytn's account |
AccountKey | Pair(s) of public/private Key for signing transactions |
Multiple Signing | Making multiple signatures on a single transaction |
Threshold | The minimum threshold of the sum of weights of keys in AccountKeyWeightedMultiSig on multiple signing |
Weight | The weight given to each key inside AccountKeyWeightedMultiSig |
RLP | Recursive length prefix |
Last updated