API 호출하기
이 페이지는 KAS Wallet API로 Klaytn 계정 생성 후 계정 정보 조회를 예시로 KAS API 호출 방법을 안내합니다.
Klaytn 계정 생성
Klaytn 계정을 생성하려면 먼저 KAS 회원에 가입, 로그인하고 API 인증 키를 받아야 합니다.
KAS 회원 가입, 로그인, API 인증 키를 받는 방법에 관한 자세한 내용은 다음을 확인하십시오.
API 인증 키가 있으면 모든 KAS 서비스를 사용할 수 있으며 Wallet API를 호출해 만든 Klaytn 계정에 대한 모든 권한을 소유합니다. 모든 권한에는 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 전송 및 실행 권한이 포함됩니다. 만약 API 인증 키에 타인이 접근한다면 Klaytn 계정 권한을 탈취당해 원치 않는 트랜잭션이 발생할 수 있습니다.
KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.
API 호출
API 인증 키를 받으면 이를 API 호출 헤더에 입력하고 Klaytn 계정 생성 API를 호출할 수 있습니다. 만약, 여러분이 KAS 콘솔에서 계정 저장소를 생성했다면 API 호출 헤더의 x-krn 파라미터에 여러분이 만든 계정 저장소 KRN을 입력해 여러분이 만든 계정 저장소에 Klaytn 계정을 생성할 수 있습니다. 계정 저장소와 x-krn 파라미터에 관한 자세한 내용은 다음을 확인하십시오.
Klaytn 계정 생성 API를 아래와 같이 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.
여러분이 자신만의 계정 저장소를 만들지 않아도 사용자가 API를 호출할 때 KAS는 기본으로 계정 저장소를 제공합니다. KAS에서 기본으로 제공하는 계정 저장소를 사용하지 않고, 자신만의 계정 저장소를 만들어서 사용하려면 KAS 콘솔에서 여러분의 계정 저장소를 먼저 만들어야 합니다.
API 호출에 사용되는
x-chain-id값은8217(Cypress) 또는1001(Baobab)입니다.API 호출에 필요한 필수 파라미터는 각 예시에 설명됩니다.
API 호출 시 사용자가 입력해야 하는 값은 중괄호 1개({})로 표시합니다. 사용자가 입력해야 하는 값은 아래 테이블과 같습니다.
chain-id
8217 또는 1001
Cypress (Klaytn 메인넷) 또는 Baobab (Klaytn 테스트넷)
access-key-id
인증 아이디
KAS 콘솔 - Security - Credential에서 발급받은 accessKeyId
secret-access-key
인증 비밀번호
KAS 콘솔 - Security - Credential에서 발급받은 secretAccessKey
krn
(optional) 계정 저장소의 ID
기본 계정 저장소 사용 시 불필요
API 응답
Klaytn 계정 생성 API의 응답은 아래와 같습니다.
이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움 받으십시오.
Klaytn 계정 조회하기
Klaytn 계정 조회 API는 생성된 Klaytn 계정의 정보를 조회할 때 사용됩니다.
API 호출
계정(EOA) 주소를 입력하고 Klaytn 계정 조회 API를 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.
API 호출에 사용되는
x-chain-id값은8217(Cypress) 또는1001(Baobab)입니다.API 호출에 필요한 필수 파라미터는 각 예시에 설명됩니다.
API 호출 시 사용자가 입력해야 하는 값은 중괄호 1개({})로 표시합니다. 사용자가 입력해야 하는 값은 아래 테이블과 같습니다.
chain-id
8217 또는 1001
Cypress (Klaytn 메인넷) 또는 Baobab (Klaytn 테스트넷)
access-key-id
인증 아이디
KAS 콘솔 - Security - Credential에서 발급받은 accessKeyId
secret-access-key
인증 비밀번호
KAS 콘솔 - Security - Credential에서 발급받은 secretAccessKey
krn
(optional) 계정 저장소의 ID
기본 계정 저장소 사용 시 불필요
API 인증 키가 있으면 모든 KAS 서비스를 사용할 수 있으며 Wallet API를 호출해 만든 Klaytn 계정에 대한 모든 권한을 소유합니다. 모든 권한에는 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 전송 및 실행 권한이 포함됩니다. 만약 API 인증 키에 타인이 접근한다면 Klaytn 계정 권한을 탈취당해 원치 않는 트랜잭션이 발생할 수 있습니다.
KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.
API 응답
Klaytn 계정 조회 API의 응답은 아래와 같습니다.
이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움 받으십시오.
Klaytn 계정 목록 조회하기
Klaytn 계정 목록 조회 API는 생성된 Klaytn 계정 목록을 조회할 때 사용됩니다.
API 호출
Klaytn 계정 목록 조회 API를 호출합니다. API 호출 시 REST API 또는 SDKs(caver-js, caver-java extensions)를 사용할 수 있습니다.
API 호출에 사용되는
x-chain-id값은8217(Cypress) 또는1001(Baobab)입니다.API 호출에 필요한 필수 파라미터는 각 예시에 설명됩니다.
API 호출 시 사용자가 입력해야 하는 값은 중괄호 1개({})로 표시합니다. 사용자가 입력해야 하는 값은 아래 테이블과 같습니다.
chain-id
8217 또는 1001
Cypress (Klaytn 메인넷) 또는 Baobab (Klaytn 테스트넷)
access-key-id
인증 아이디
KAS 콘솔 - Security - Credential에서 발급받은 accessKeyId
secret-access-key
인증 비밀번호
KAS 콘솔 - Security - Credential에서 발급받은 secretAccessKey
krn
(optional) 계정 저장소의 ID
기본 계정 저장소 사용 시 불필요
API 인증 키가 있으면 모든 KAS 서비스를 사용할 수 있으며 Wallet API를 호출해 만든 Klaytn 계정에 대한 모든 권한을 소유합니다. 모든 권한에는 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 전송 및 실행 권한이 포함됩니다. 만약 API 인증 키에 타인이 접근한다면 Klaytn 계정 권한을 탈취당해 원치 않는 트랜잭션이 발생할 수 있습니다.
KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.
쿼리 파라미터 여러분은 커서 방식 페이지네이션을 사용해 API 응답값을 받아올 수 있습니다. 검색 범위를 초단위로 지정할 수 있습니다.
size
응답 아이템 개수 (min=1, max=1000, default=100)
size=100
False
cursor
페이지네이션으로 다음 요청을 보낼 때 필요한 커서
cursor=J9Ag...VM6z
False
to-timestamp
검색 범위: 마지막 시간의 타임스탬프 (초단위)
to-timestamp=15921809920
False
from-timestamp
검색 범위: 시작 시간의 타임스탬프 (초단위)
from-timestamp=1592360291
False
API 응답
Klaytn 계정 목록 조회 API의 응답은 아래와 같습니다.
KAS API를 호출해 데이터를 불러올 때 모든 데이터를 한 번에 가져오기 어려울 때가 있습니다. 이 때 API를 여러 번 호출하여 지정된 개수만큼 데이터를 분할하여 불러오는데, 보통 데이터를 페이지 단위로 나눠 불러오기 때문에 이를 **페이지네이션(Pagination)**이라고 합니다. 자세한 내용은 여기에서 확인하세요.
이 API에 관한 자세한 내용은 다음을 확인하십시오. 이 문서 혹은 KAS에 관한 문의는 개발자 포럼을 방문해 도움 받으십시오.
Last updated