API ของสินทรัพย์มีให้บริการในการลงทะเบียนและเรียกคืนข้อมูลเกี่ยวกับสินทรัพย์ เช่น ไฟล์สื่อ
อัปโหลดสินทรัพย์
อัปโหลดทรัพย์สิน (ไฟล์มีเดียเช่น jpg, png, gif, ฯลฯ) ไปยัง IPFS สาธารณะ (InterPlanetary File System) มันเสนอที่อยู่ (uri
) ของทรัพย์สินที่อัปโหลดไปยัง IPFS และที่อยู่เกตเวย์ (gatewayUrl
) ที่สามารถเข้าถึงได้ผ่าน HTTP.
URL การร้องขอ
พารามิเตอร์หัว
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
Authorization | โทเค็นการตรวจสอบสิทธิ์ที่จำเป็นในการเรียก API | string | Y |
เนื้อหาคำขอ
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
asset | ข้อมูลไบนารีเกี่ยวกับไฟล์สื่อที่จะอัปโหลด | string | Y |
การตอบสนอง
ชื่อฟิลด์ | คำอธิบาย | ประเภท |
code | รหัสผลลัพธ์ของคำขอ API, 0: สำเร็จ | หมายเลข |
message | ข้อความผลลัพธ์ | สตริง |
data | ข้อมูลการตอบกลับของ API | json |
data.contentType | ประเภทของเนื้อหา | สตริง |
data.uri | ที่อยู่ IPFS ที่อัปโหลดสินทรัพย์ | สตริง |
data.gatewayUrl | ที่อยู่เกตเวย์ที่สามารถพบสินทรัพย์ได้ | สตริง |
ตัวอย่างคำขอ
curl -X 'POST'
'https://sandbox-bc-api.qpyou.cn/core/v1/asset'
-H 'accept: application/json'
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO'
-H 'Content-Type: multipart/form-data'
-F 'asset=@cw20.code'
ตัวอย่างการตอบกลับ
{
"code": 0,
"message": "success",
"data": {
"contentType": "application/octet-stream",
"uri": "ipfs://QmPStJZ7o4kSQH2R64sRWq8YpJ9VgDb1QoHjAmyhCmekTi",
"gatewayUrl": "https://sandbox-bc-file.qpyou.cn/ipfs/QmPStJZ7o4kSQH2R64sRWq8YpJ9VgDb1QoHjAmyhCmekTi"
}
}
อัปโหลดสินทรัพย์ด้วย URL สาธารณะ
อัปโหลดทรัพย์สิน (ไฟล์มีเดียเช่น jpg, png, gif, ฯลฯ) ไปยัง IPFS สาธารณะ แทนที่จะอัปโหลดไฟล์โดยตรง ให้ทำการอัปโหลดผ่าน URL สาธารณะ มันจะให้ที่อยู่ (uri
) ของทรัพย์สินที่อัปโหลดไปยัง IPFS และที่อยู่เกตเวย์ (gatewayUrl
) ที่สามารถเข้าถึงได้ผ่าน HTTP
URL ที่ร้องขอ
พารามิเตอร์หัว
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
Authorization | โทเค็นการตรวจสอบสิทธิ์ที่จำเป็นในการเรียก API | string | Y |
เนื้อหาคำขอ
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
url | URL สาธารณะที่สินทรัพย์จะถูกอัปโหลดไป | string | Y |
การตอบสนอง
ชื่อฟิลด์ | คำอธิบาย | ประเภท |
code | รหัสผลลัพธ์การร้องขอ API, 0: สำเร็จ | หมายเลข |
message | ข้อความผลลัพธ์ | สตริง |
data | ข้อมูลการตอบกลับ API | json |
data.contentType | ประเภทเนื้อหา | สตริง |
data.uri | ที่อยู่ IPFS ที่อัปโหลดสินทรัพย์ | สตริง |
data.gatewayUrl | ที่อยู่เกตเวย์ที่สามารถพบสินทรัพย์ได้ | สตริง |
ตัวอย่างคำขอ
curl -X 'POST'
'https://sandbox-bc-api.qpyou.cn/core/v1/asset-by-url'
-H 'accept: application/json'
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO'
-H 'Content-Type: application/json'
-d '{
"url": "https://image01.c2x.world/equip_92053030.gif"
}'
ตัวอย่างการตอบกลับ
{
"code": 0,
"message": "success",
"data": {
"contentType": "image/gif",
"uri": "ipfs://QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF",
"gatewayUrl": "https://sandbox-bc-file.qpyou.cn/ipfs/QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF"
}
}
รับข้อมูลสินทรัพย์
รับ URL ของสินทรัพย์ที่เปิดให้สาธารณะ โดยใช้ตัวระบุเนื้อหา (cid
).
URL การร้องขอ
พารามิเตอร์หัวเรื่อง
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
Authorization | โทเค็นการตรวจสอบสิทธิ์ที่จำเป็นในการเรียก API | string | Y |
พารามิเตอร์เส้นทาง
ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
cid | นี่คือรหัสระบุเนื้อหาของ IPFS นี่คือค่าแฮชที่ใช้ในการระบุข้อมูลใน IPFS และสามารถพบได้ใน uri (ipfs://{CID}) หรือ gatewayUrl (https://{GATEWAY_URL}/ipfs/{CID}) | สตริง | ใช่ |
การตอบสนอง
ชื่อฟิลด์ | คำอธิบาย | ประเภท |
code | รหัสผลลัพธ์การร้องขอ API, 0: สำเร็จ | number |
message | ข้อความผลลัพธ์ | String |
data | ข้อมูลการตอบกลับ API | json |
data.assetUri | ที่อยู่เกตเวย์ที่สามารถพบสินทรัพย์ได้ | string |
ตัวอย่างคำขอ
curl -X 'GET'
'https://sandbox-bc-api.qpyou.cn/core/v1/asset/QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF'
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXlObyI6MSwiaWQiOiJwbGF0Zm9ybSIsImNvbXBhbnkiO'
-H 'accept: application/json'
ตัวอย่างการตอบกลับ
{
"code": 0,
"message": "success",
"data": {
"assetUri": "https://sandbox-bc-file.qpyou.cn/ipfs/QmV7GWnGgQU3szBBDQz1MmigtUjddmuAt7SjrWZeXP6cVF"
}
}