Metadata API

Download OpenAPI specification:Download

Introduction

Metadata API는 블록체인 어플리케이션(BApp) 개발자들이 에셋(asset)과 메타데이터(metadata)를 관리할 수 있게 도와주는 RESTful API입니다.

에셋과 메타데이터는 Klaytn의 대체불가토큰 기술표준인 KIP-17 토큰(NFT), Klaytn의 멀티토큰 기술표준인 KIP-37 토큰(MT)을 발행할 때 사용합니다.

에셋이란 NFT나 MT가 가지고 있는 그림, 영상 등을 지칭합니다. NFT나 MT 발행시 우선 에셋을 업로드하고, 결과값으로 나오는 에셋의 URI를 메타데이터에 포함하여 발행하는 것입니다. 메타데이터란 본래 “데이터에 대한 데이터“를 의미하는데, NFT나 MT의 메타데이터의 경우 토큰의 속성(이름, 설명, 이미지 URL 등)을 나타내는 데이터를 뜻합니다. JSON 파일 형식으로 저장됩니다.

Metadata API를 사용하여 다음의 작업을 수행할 수 있습니다.

  • 에셋 업로드
  • 메타데이터 업로드
  • 에셋과 메타데이터에 대해 외부 접근이 가능한 URI 제공

Error Code

Metadata API 호출 시 요청에 대한 응답으로 발생할 수 있는 에러 코드입니다. KAS는 HTTP 상태 코드를 표준으로 따릅니다. 테이블은 여기에서 확인하세요.

Authentication

basic

KAS는 Basic HTTP Auth를 사용합니다. 모든 요청은 반드시 올바른 Authorization 헤더를 가져야 하며 KAS 사용자는 access key ID를 username으로, secret access key를 password로 사용하여 Basic Auth에 사용할 자격증명을 생성합니다.

참고

KAS 계정의 각 Credential은 모든 KAS 서비스를 사용할 수 있으며, Wallet API로 만든 Klaytn 계정에 대한 모든 권한을 소유하기 때문에, 생성한 Klaytn 계정의 자산(KLAY 등) 이동이나 트랜잭션 실행 권한을 가집니다. KAS/Klaytn 계정 보안을 위해 KAS API 인증 키(Secret Access Key)를 타인과 함부로 공유하지 말고 주의해 관리하십시오.

cURL

  curl --location --request GET 'https://kip7-api.klaytnapi.com/v1/contract' \
  -u ${your_accessKeyId}:${your_secretAccessKey} \
  --header 'x-chain-id: 1001' \
  --header 'Content-Type: application/json'
Security Scheme Type HTTP
HTTP Authorization Scheme basic