Klip Docs
Search…
Introduction
Basics
REST API
Card Minting
App2App
App2App SDK
Tutorial
Change Log
Powered By GitBook
Card Minting
이 페이지는 Klip Partners에 로그인하고 카드를 발행, 조회, 전송, 삭제하기 위한 API를 소개합니다.

계정 관리

계정 관리 API에는 로그인(Sign In), 비밀번호 변경(Change Password), 핀 번호 변경(Change Pin)이 있습니다.

Sign In

post
https://api.klipwallet.com
/v2/partner/auth
Sign In
​Klip Partners는 현재 허가된 사용자만 접근이 가능합니다. 서비스 이용을 희망하는 파트너사는 원활한 사업 논의를 위해서 (1)회사 소개, (2)카드 활용 목적, (3)카드 활용 방안 등을 서면으로 정리해 [email protected]로 보내주시길 바랍니다.
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/partner/auth" \
2
-d '{"email":"[email protected]", "password":"C01069C9ABB6EA7DA49AE418A24BBEF3AD67170DDCD20AC7C76084A5A85E4057"}' \
3
-H "Content-Type: application/json"
Copied!
Response Details
이름
타입
설명
email
string
가입자 이메일 주소이며 로그인 계정으로 사용됩니다.
klaytn_address
string
가입자 Klaytn EOA 주소입니다.
contract_address
string
카드를 발행하는 SCA 주소입니다.
name
string
가입자 이름이며 사업자 또는 법인 이름을 사용합니다.
phone
string
가입자 전화번호입니다.
service_name
string
가입자가 제공하는 BApp 서비스 이름입니다.
access_token
string
JWT 형식으로 API 호출을 허용하기 위해 발급된 인증 토큰입니다.
status
number
계정 상태코드입니다.
mint_limit
number
계정이 이번 달에 발행할 수 있는 최대 카드 개수입니다.
mint_count
number
계정이 이번 달에 발행한 카드 개수입니다.
status는 가입 승인 전에는 20, 가입 승인 후에는 1의 값을 가집니다. access_token은 발급받은 지 24시간이 지나면 만료되므로 재발급받아야 합니다. mint_count와 mint_limit은 매달 1일 초기화됩니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Change Password

put
https://api.klipwallet.com
/v2/partner/?opt=password
Change Password
Request Example
1
curl -X PUT "https://api.klipwallet.com/v2/partner/?opt=password" \
2
-d '{"old_password":"HASHED_OLD_PASSWORD", "new_password":"HASHED_NEW_PASSWORD"}' \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Change PIN

put
https://api.klipwallet.com
/v2/partner/pin
Change PIN
Request Example
1
curl -X PUT "https://api.klipwallet.com/v2/partner/pin" \
2
-d '{"old_pin":"HASHED_OLD_PIN_NUMBER", "new_pin":"HASHED_NEW_PIN_NUMBER"}' \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

카드 관리

카드 관리 API에는 카드 이미지 업로드(Upload Image), 모든 사용자에게 카드 발행(Mint Card To User), Klip 회원에게 카드 발행(Mint Card To Klip Member), 모든 사용자에게 카드 전송(Send Card To User), Klip 회원에게 카드 전송(Send Card To Klip Member), 카드 정보 불러오기(Get Card Information By Bapp, Get Card Information), 카드 삭제(Delete Card)가 있습니다.

Upload Image

post
https://api.klipwallet.com
/v2/wallet/image
Upload Image
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/image" \
2
-F [email protected]/imagefile.png \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: multipart/form-data"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Upload NFT Resource

post
https://api.klipwallet.com
/v2/wallet/nftResource
Upload NFT resource
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/nftResource" \
2
-F [email protected]/file.mp4 \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: multipart/form-data"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Mint Card to User

post
https://api.klipwallet.com
/v2/wallet/mint
Mint Card To User
1
//attributes 예시
2
attributes:[
3
{
4
"trait_type": "Sword",
5
"value": "Iron Short Sword"
6
},
7
{
8
"trait_type": "Magic Type",
9
"value": "Fire"
10
},
11
{
12
"trait_type": "Sword Level",
13
"value": "5"
14
},
15
{
16
"trait_type": "Magic Level",
17
"value": "2"
18
}
19
]
Copied!
1
//secure 예시 (일반적으로 bar_code 또는 qr_code 둘 중 하나만 설정)
2
secure: {
3
bar_code: "1234 ABCD 5678 EFGH 90IJ",
4
qr_code: "https://your-domain.com?key=1234",
5
attributes:[
6
{
7
"trait_type": "Sword",
8
"value": "Iron Short Sword"
9
},
10
{
11
"trait_type": "Magic Type",
12
"value": "Fire"
13
},
14
{
15
"trait_type": "Sword Level",
16
"value": "5"
17
},
18
{
19
"trait_type": "Magic Level",
20
"value": "2"
21
}
22
]
23
}
Copied!
1
//status_url 예시
2
status_url: "https://your-domain.com?key=1234"
3
​
4
//status_url 호출 시 응답값 예시
5
{
6
valid: true,
7
attributes:[
8
{
9
"trait_type": "Sword",
10
"value": "Iron Short Sword"
11
},
12
{
13
"trait_type": "Magic Type",
14
"value": "Fire"
15
},
16
{
17
"trait_type": "Sword Level",
18
"value": "5"
19
},
20
{
21
"trait_type": "Magic Level",
22
"value": "2"
23
}
24
]
25
}
Copied!
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/mint" \
2
-d @./mint_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Request Details for secure
이름
타입
설명
bar_code
string
bar code로 표시할 문자열 값입니다. 기본적으로 CODE 128 형식을 사용합니다. optional 필드입니다. (최대 길이:20, ' '(공백) 또는 '-' 문자 제외)
qr_code
string
qr code로 표시할 문자열 값입니다. optional 필드입니다. (최대 길이:255)
attributes
array
카드 속성값들이 담긴 object 배열입니다. optional 필드입니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Mint Card to Klip Member

post
https://api.klipwallet.com
/v2/wallet/mint/person
Mint Card To Klip Member
1
//attributes 예시
2
attributes:[
3
{
4
"trait_type": "Sword",
5
"value": "Iron Short Sword"
6
},
7
{
8
"trait_type": "Magic Type",
9
"value": "Fire"
10
},
11
{
12
"trait_type": "Sword Level",
13
"value": "5"
14
},
15
{
16
"trait_type": "Magic Level",
17
"value": "2"
18
}
19
]
Copied!
1
//secure 예시 (일반적으로 bar_code 또는 qr_code 둘 중 하나만 설정)
2
secure: {
3
bar_code: "1234 ABCD 5678 EFGH 90IJ",
4
qr_code: "https://your-domain.com?key=1234",
5
attributes:[
6
{
7
"trait_type": "Sword",
8
"value": "Iron Short Sword"
9
},
10
{
11
"trait_type": "Magic Type",
12
"value": "Fire"
13
},
14
{
15
"trait_type": "Sword Level",
16
"value": "5"
17
},
18
{
19
"trait_type": "Magic Level",
20
"value": "2"
21
}
22
]
23
}
Copied!
1
//status_url 예시
2
status_url: "https://your-domain.com?key=1234"
3
​
4
//status_url 호출 시 응답값 예시
5
{
6
valid: true,
7
attributes:[
8
{
9
"trait_type": "Sword",
10
"value": "Iron Short Sword"
11
},
12
{
13
"trait_type": "Magic Type",
14
"value": "Fire"
15
},
16
{
17
"trait_type": "Sword Level",
18
"value": "5"
19
},
20
{
21
"trait_type": "Magic Level",
22
"value": "2"
23
}
24
]
25
}
Copied!
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/mint/person" \
2
-d @./mint_person_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Request Details for secure
이름
타입
설명
bar_code
string
bar code로 표시할 문자열 값입니다. 기본적으로 CODE 128 형식을 사용합니다. optional 필드입니다. (최대 길이:20, ' '(공백) 또는 '-' 문자 제외)
qr_code
string
qr code로 표시할 문자열 값입니다. optional 필드입니다. (최대 길이:255)
attributes
array
카드 속성값들이 담긴 object 배열입니다. optional 필드입니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Mint Count

get
https://api.klipwallet.com
/v2/wallet/mint/count
Get Mint Count
Request Example
1
curl -X GET "https://api.klipwallet.com/v2/wallet/mint/count" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Response Details
이름
타입
설명
mint_count
number
이번 달 현재까지 발행한 카드 개수입니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Send Card to User

post
https://api.klipwallet.com
/v2/wallet/nft/:nft_id/:card_id/send
Send Card To User
Klip 사용자에게 카드를 전송 시card_name을 입력해야 받는 사람에게 카드 이름이 표시됩니다.
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/nft/60/1/send" \
2
-d @./send_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Send Card to Klip Member

post
https://api.klipwallet.com
/v2/wallet/nft/:nft_id/:card_id/send/person
Send Card To Klip Member
Klip 사용자에게 카드를 전송 시card_name을 입력해야 받는 사람에게 카드 이름이 표시됩니다.
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/wallet/nft/60/1/send/person" \
2
-d @./send_person_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Card Information by Bapp

get
https://api.klipwallet.com
/v2/wallet/bapp?cursor=
Get Card Information By BApp
Request Example
1
curl "https://api.klipwallet.com/v2/wallet/bapp?cursor=mrzedXOE9OeEorkAvwQXB7JdVg4LP1Rzze2kLQFxLU4C8iMOhOVulzIr5iesZoie9uv9h87UNXsWCKdhqYszXFWLsYYI7h125Rx8p56qlMKaZ20YbNW3zDGmNBJKM1wL" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Response Details for bapps[i]
이름
타입
설명
id
number
이 BApp ID입니다.
name
string
이 BApp 이름입니다.
bapp_img
string
이 BApp 대표 이미지 파일 주소입니다.
category_id
number
이 BApp 카테고리 분류 코드입니다.
nft_order_no
number
Klip 카드 목록에서 카드 그룹이 노출되는 순서입니다.
summary
string
이 BApp에 관한 한 줄 설명입니다.
card_count
number
보유한 모든 카드중 이 BApp에서 쓰이는 카드 개수입니다.
nft_id
number
NFT ID입니다. NFT는 이 카드를 블록체인에 구현하는 스마트 컨트랙트입니다.
cards
array
각 카드 정보를 담은 object 배열입니다.
cards_next_cursor
string
카드가 100개 이상이면 다음 100개 정보를 불러올 커서값입니다.
next_cursor
string
BApp이 100개 이상이면 다음 100개 정보를 불러올 커서값입니다.
Response Details for bapps[i].cards[i]
이름
타입
설명
created_at
number
카드가 발행된 시간입니다.
updated_at
number
카드가 업데이트된 시간입니다.
owner
string
이 계정 EOA 주소입니다.
sender
string
이 계정으로 카드를 보낸 사람의 EOA 주소입니다.
card_id
number
카드 ID입니다.
card_uri
string
카드 메타데이터가 담긴 JSON 파일 URL입니다.
transaction_hash
string
카드를 발행한 스마트 컨트랙트 트랜잭션 해시입니다.
자세한 내용은 튜토리얼1, 튜토리얼2를 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Card Information

get
https://api.klipwallet.com
/v2/wallet/nft/:nft_id?cursor=
Get Card Information
Request Example
1
curl "https://api.klipwallet.com/v2/wallet/nft/52?cursor=mrzedXOE9OeEorkAvwQXB7JdVg4LP1Rzze2kLQFxLU4C8iMOhOVulzIr5iesZoie9uv9h87UNXsWCKdhqYszXFWLsYYI7h125Rx8p56qlMKaZ20YbNW3zDGmNBJKM1wL" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Response Details
이름
타입
설명
name
string
카드 이름입니다.
symbol_img
string
카드에 사용하는 이미지 URL 주소입니다.
cards
array
각 카드 정보를 담은 object 배열입니다.
next_cursor
string
카드가 100개 이상이면 다음 100개 정보를 불러올 커서값입니다.
Response Details for cards[i]
이름
타입
설명
created_at
number
카드가 발행된 시간입니다.
updated_at
number
카드가 업데이트된 시간입니다.
owner
string
이 계정 EOA 주소입니다.
sender
string
이 계정으로 카드를 보낸 사람의 EOA 주소입니다.
card_id
number
카드 ID입니다.
card_uri
string
카드 메타데이터가 담긴 JSON 파일 URL입니다.
transaction_hash
string
카드를 발행한 스마트 컨트랙트 트랜잭션 해시입니다.
자세한 내용은 튜토리얼1, 튜토리얼2를 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Delete Card

delete
https://api.klipwallet.com
/v2/wallet/nft
Delete Card
발행한 카드만 삭제할 수 있으며, 다른 사람에게 보낸 카드는 삭제할 수 없습니다. 카드를 삭제해도 카드 이미지는 삭제되지 않습니다.
Request Example
1
curl -X DELETE "https://api.klipwallet.com/v2/wallet/nft" \
2
-d @./delete_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Approve Escrow

post
https://api.klipwallet.com
/v2/escrow/approve
Approve Escrow
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/escrow/approve" \
2
-d @./approve_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Escrow Approval Status

get
https://api.klipwallet.com
/v2/escrow/approve
Get Escrow Approval Status
Request Example
1
curl -X GET "https://api.klipwallet.com/v2/escrow/approve?contract_address=0xc94770007dda54cF92009BFF0dE90c06F603a09f" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Create Escrow

post
https://api.klipwallet.com
/v2/escrow
Create Escrow
보유중인 카드만 에스크로 전송을 실행 할 수 있으며, 다른 사람에게 보낸 카드는 전송할 수 없습니다. 에스크로를 수행한 카드는 에스크로 카드 조회를 통해 확인할 수 있습니다.
Request Example
1
curl -X POST "https://api.klipwallet.com/v2/escrow" \
2
-d @./escrow_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Cards in Escrow

get
https://api.klipwallet.com
/v2/escrow
Get Cards in Escrow
cursor에 대한 자세한 내용은 pagination 항목을 참조하십시오.
Request Example
1
curl -X GET "https://api.klipwallet.com/v2/escrow?contract_address=0xc94770007dda54cF92009BFF0dE90c06F603a09f" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Response Details
이름
타입
설명
name
string
카드 이름입니다.
symbol_img
string
카드에 사용하는 이미지 URL 주소입니다.
cards
array
각 카드 정보를 담은 object 배열입니다.
next_cursor
string
카드가 100개 이상이면 다음 100개 정보를 불러올 커서값입니다.
Response Details for cards[i]
이름
타입
설명
created_at
number
카드가 발행된 시간입니다.
updated_at
number
카드가 업데이트된 시간입니다.
owner
string
이 계정 EOA 주소입니다.
sender
string
이 계정으로 카드를 보낸 사람의 EOA 주소입니다.
card_id
number
카드 ID입니다.
card_uri
string
카드 메타데이터가 담긴 JSON 파일 URL입니다.
transaction_hash
string
카드를 발행한 스마트 컨트랙트 트랜잭션 해시입니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Cancel Escrow

delete
https://api.klipwallet.com
/v2/escrow
Cancel Escrow
에스크로된 카드만 취소할 수 있으며, 이미 지급된 카드는 삭제할 수 없습니다. 취소된 카드는 보유 목록으로 되돌아 갑니다.
Request Example
1
curl -X DELETE "https://api.klipwallet.com/v2/escrow" \
2
-d @./cancel_info.json \
3
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.

Get Transaction Result

get
https://api.klipwallet.com
/v2/wallet/receipt
Get Transaction Result
Request Example
1
curl -X GET "https://api.klipwallet.com/v2/wallet/receipt?tx_hash=0x880a45d3c482c7d794c2e7b7dbdc9e933a68f4a1f3d978d582ba9f9ebd1f9e72" \
2
-H "Authorization: ACCESS_TOKEN" -H "Content-Type: application/json"
Copied!
Response Details
이름
타입
설명
success
bool
트랜잭션 성공 여부입니다.
자세한 내용은 튜토리얼을 확인하십시오. 이 문서 혹은 Klip에 관한 문의는 개발자 포럼을 방문해 도움을 받으십시오.
Previous
REST API
Next
App2App
Last modified 8h ago
Copy link
Contents
계정 관리
Sign In
post
Sign In
Change Password
put
Change Password
Change PIN
put
Change PIN
카드 관리
Upload Image
post
Upload Image
Upload NFT Resource
post
Upload NFT resource
Mint Card to User
post
Mint Card To User
Mint Card to Klip Member
post
Mint Card To Klip Member
Get Mint Count
get
Get Mint Count
Send Card to User
post
Send Card To User
Send Card to Klip Member
post
Send Card To Klip Member
Get Card Information by Bapp
get
Get Card Information By BApp
Get Card Information
get
Get Card Information
Delete Card
delete
Delete Card
Approve Escrow
post
Approve Escrow
Get Escrow Approval Status
get
Get Escrow Approval Status
Create Escrow
post
Create Escrow
Get Cards in Escrow
get
Get Cards in Escrow
Cancel Escrow
delete
Cancel Escrow
Get Transaction Result
get
Get Transaction Result