การยืนยันตัวตน
StarDots ทำการยืนยันตัวตนโดยการอ่านฟิลด์ headers ในคำขอ HTTP ที่เริ่มต้นจากลูกค้าและตรวจสอบฟิลด์ที่เกี่ยวข้อง ดังนั้นคำขอ API ทั้งหมดจะต้องมีข้อมูลฟิลด์การยืนยันตัวตนเหล่านี้ และคุณต้องระวังว่าเหล่านี้เป็นฟิลด์ที่ไวต่อการใช้ตัวอักษรพิมพ์ใหญ่-พิมพ์เล็ก และฟิลด์ทั้งหมดควรเป็นตัวพิมพ์เล็ก
| ชื่อ | คำอธิบาย |
|---|---|
x-stardots-timestamp | เวลาปัจจุบันในหน่วยวินาที ความแตกต่างกับเซิร์ฟเวอร์ StarDots ไม่สามารถเกิน 60 วินาที หมายเหตุ: เขตเวลาของ StarDots คือ Asia/Singapore ซึ่งเป็น UTC+8 |
x-stardots-nonce | สตริงสุ่มที่มีความยาว 4 ถึง 20 ตัวอักษร ซึ่งสามารถประกอบด้วยตัวอักษรพิมพ์ใหญ่ ตัวอักษรพิมพ์เล็ก และตัวเลข หมายเหตุ: ค่านี้ต้องไม่ซ้ำกันภายใน 60 วินาที |
x-stardots-key | ข้อมูลคีย์ที่ออกโดย StarDots |
x-stardots-sign | ฟิลด์ลายเซ็นเป็นสตริงที่สร้างขึ้นจากการรวมฟิลด์ข้างต้นตามอัลกอริธึมลายเซ็นที่กำหนด อัลกอริธึมลายเซ็นเฉพาะจะถูกอธิบายในตอนถัดไป |
x-stardots-timestamp- คำอธิบาย
- เวลาปัจจุบันในหน่วยวินาที ความแตกต่างกับเซิร์ฟเวอร์ StarDots ไม่สามารถเกิน 60 วินาที หมายเหตุ: เขตเวลาของ StarDots คือ Asia/Singapore ซึ่งเป็น UTC+8
x-stardots-nonce- คำอธิบาย
- สตริงสุ่มที่มีความยาว 4 ถึง 20 ตัวอักษร ซึ่งสามารถประกอบด้วยตัวอักษรพิมพ์ใหญ่ ตัวอักษรพิมพ์เล็ก และตัวเลข หมายเหตุ: ค่านี้ต้องไม่ซ้ำกันภายใน 60 วินาที
x-stardots-key- คำอธิบาย
- ข้อมูลคีย์ที่ออกโดย StarDots
x-stardots-sign- คำอธิบาย
- ฟิลด์ลายเซ็นเป็นสตริงที่สร้างขึ้นจากการรวมฟิลด์ข้างต้นตามอัลกอริธึมลายเซ็นที่กำหนด อัลกอริธึมลายเซ็นเฉพาะจะถูกอธิบายในตอนถัดไป
อัลกอริธึมลายเซ็น
เราสมมติค่าฟิลด์ดังต่อไปนี้
key2dcded8e-f231-4d0a-8498-d10ef0639eb3secretEy1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNpx-stardots-timestamp1728958751x-stardots-noncefQvDmMLnKEx-stardots-key2dcded8e-f231-4d0a-8498-d10ef0639eb3
จากนั้นเราจะรวมค่าฟิลด์ข้างต้น
needSignStr = x-stardots-timestamp + "|" + secret + "|" + x-stardots-nonceถัดไป เราจะคำนวณค่าฮัช MD5 ของสตริงที่รวมกันข้างต้น
signStrAfterMD5 = md5("1728958751|Ey1JNRCiJOzaIOIilcyJvteTn5YXykFXUwmiHLymK8LHkITfGPo5mTUdLlg0jPHST9fMwMZKxIKUBvSsT5uxrq0lXuerll3eRW2tbMOsvySRY539L8cR6iRFV2DQqdlzbseyq7k9N0U5pZgj6f43e3MngbIttgSDl1G44IBOwqsI2HVXE5H6mf1bHlvWw6Ziuk8Xcw18AioG47SFBLIatrq6E9yEBJgFgcYysCH8JvY659hhqI3Ii1CA5zVtyNp|fQvDmMLnKE")
signStrAfterMD5 = "51dabfe4b47e73d4a3b85fe29c4f1e82"สุดท้ายเราจะแปลงสตริงสรุปให้เป็นตัวพิมพ์ใหญ่
sign = signStrAfterMD5.toUpperCase()
sign = "51DABFE4B47E73D4A3B85FE29C4F1E82"ดังนั้นค่าที่ได้สุดท้ายของฟิลด์ x-stardots-sign คือ 51DABFE4B47E73D4A3B85FE29C4F1E82
ร่างการตอบกลับ HTTP ทั่วไป
การตอบกลับจากอินเตอร์เฟซทั้งหมดจะรักษารูปแบบข้อมูลที่เป็นเอกภาพ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
code | number | ใช่ | รหัสการตอบกลับของบริการ 200 หมายถึงความสำเร็จ |
message | string | ใช่ | ข้อความที่แสดงผลลัพธ์ของการดำเนินการ |
requestId | string | ใช่ | หมายเลขที่ไม่ซ้ำกันสำหรับคำขอ ซึ่งสามารถใช้ในการแก้ไขปัญหา |
success | boolean | ใช่ | ระบุว่า การดำเนินการธุรกิจสำเร็จหรือไม่ |
ts | number | ใช่ | รหัสเวลาของเซิร์ฟเวอร์ในหน่วยมิลลิวินาที |
data | any | ใช่ | ฟิลด์ข้อมูลธุรกิจ ฟิลด์นี้สามารถเป็นประเภทข้อมูลใดก็ได้ สำหรับประเภทข้อมูลเฉพาะ โปรดดูที่อินเตอร์เฟซที่เกี่ยวข้อง |
code- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- รหัสการตอบกลับของบริการ 200 หมายถึงความสำเร็จ
message- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ข้อความที่แสดงผลลัพธ์ของการดำเนินการ
requestId- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- หมายเลขที่ไม่ซ้ำกันสำหรับคำขอ ซึ่งสามารถใช้ในการแก้ไขปัญหา
success- ประเภทข้อมูล
boolean- จำเป็น
- ใช่
- คำอธิบาย
- ระบุว่า การดำเนินการธุรกิจสำเร็จหรือไม่
ts- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- รหัสเวลาของเซิร์ฟเวอร์ในหน่วยมิลลิวินาที
data- ประเภทข้อมูล
any- จำเป็น
- ใช่
- คำอธิบาย
- ฟิลด์ข้อมูลธุรกิจ ฟิลด์นี้สามารถเป็นประเภทข้อมูลใดก็ได้ สำหรับประเภทข้อมูลเฉพาะ โปรดดูที่อินเตอร์เฟซที่เกี่ยวข้อง
อินเตอร์เฟซฟังก์ชัน
โปรดทราบว่าอินเตอร์เฟซทั้งหมดจะมีการจำกัดอัตราการร้องขอ และอินเตอร์เฟซทั้งหมดใช้กฎการจำกัดอัตราเดียวกัน จนถึงปัจจุบัน StarDots มีการจำกัดอัตราการร้องขอ 300 ครั้งต่อนาที
จุดสิ้นสุดการร้องขอ
https://api.stardots.ioรายการพื้นที่
ดึงข้อมูลรายการพื้นที่
- วิธีการร้องขอ
GET- เส้นทางคำขอ
/openapi/space/list- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาการตอบกลับ
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
page | number | ไม่ | หมายเลขหน้า ค่าเริ่มต้นคือ 1 |
pageSize | number | ไม่ | จำนวนรายการต่อหน้าอยู่ในช่วง 1 ถึง 100 ค่าเริ่มต้นคือ 20 |
page- ประเภทข้อมูล
number- จำเป็น
- ไม่
- คำอธิบาย
- หมายเลขหน้า ค่าเริ่มต้นคือ 1
pageSize- ประเภทข้อมูล
number- จำเป็น
- ไม่
- คำอธิบาย
- จำนวนรายการต่อหน้าอยู่ในช่วง 1 ถึง 100 ค่าเริ่มต้นคือ 20
ตัวอย่างคำขอ
/openapi/space/list?page=1&pageSize=50ฟิลด์การตอบกลับ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
name | string | ใช่ | ชื่อของพื้นที่ |
public | boolean | ใช่ | ระบุว่า การเข้าถึงพื้นที่นั้นเป็นแบบเปิดหรือไม่ |
createdAt | number | ใช่ | รหัสเวลาของระบบเมื่อพื้นที่ถูกสร้างขึ้น เวลาอยู่ในโซน UTC+8 |
fileCount | number | ใช่ | จำนวนไฟล์ในพื้นที่นี้ |
name- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่
public- ประเภทข้อมูล
boolean- จำเป็น
- ใช่
- คำอธิบาย
- ระบุว่า การเข้าถึงพื้นที่นั้นเป็นแบบเปิดหรือไม่
createdAt- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- รหัสเวลาของระบบเมื่อพื้นที่ถูกสร้างขึ้น เวลาอยู่ในโซน UTC+8
fileCount- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- จำนวนไฟล์ในพื้นที่นี้
ตัวอย่างการตอบกลับ
{
"code": 200,
"data": [
{
"createdAt": 1723789637,
"fileCount": 2,
"name": "star",
"public": true
}
],
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}สร้างพื้นที่
สร้างพื้นที่ใหม่
- วิธีการร้องขอ
PUT- เส้นทางคำขอ
/openapi/space/create- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
public | boolean | ไม่ | ระบุว่าพื้นที่นี้สามารถเข้าถึงได้สาธารณะหรือไม่ ค่าเริ่มต้นคือ false |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
public- ประเภทข้อมูล
boolean- จำเป็น
- ไม่
- คำอธิบาย
- ระบุว่าพื้นที่นี้สามารถเข้าถึงได้สาธารณะหรือไม่ ค่าเริ่มต้นคือ false
ตัวอย่างคำขอ
{
"public": false,
"space": "stardots"
}ฟิลด์การตอบกลับ
ไม่มีฟิลด์
ตัวอย่างผลลัพธ์
{
"code": 200,
"data": null,
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}ลบพื้นที่
ลบพื้นที่ที่มีอยู่ โปรดตรวจสอบให้แน่ใจว่าไม่มีไฟล์ในพื้นที่นี้ มิฉะนั้นการลบจะล้มเหลว
- วิธีการร้องขอ
DELETE- เส้นทางคำขอ
/openapi/space/delete- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
ตัวอย่างคำขอ
{
"space": "stardots"
}ฟิลด์การตอบกลับ
ไม่มีฟิลด์
ตัวอย่างผลลัพธ์
{
"code": 200,
"data": null,
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}การเข้าถึงพื้นที่
สลับการเข้าถึงของพื้นที่
- วิธีการร้องขอ
POST- เส้นทางคำขอ
/openapi/space/accessibility/toggle- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
public | boolean | ไม่ | ระบุว่าพื้นที่สามารถเข้าถึงได้สาธารณะหรือไม่ ค่าปริยายคือ false |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
public- ประเภทข้อมูล
boolean- จำเป็น
- ไม่
- คำอธิบาย
- ระบุว่าพื้นที่สามารถเข้าถึงได้สาธารณะหรือไม่ ค่าปริยายคือ false
ตัวอย่างคำขอ
{
"public": false,
"space": "stardots"
}ฟิลด์การตอบกลับ
ไม่มีฟิลด์
ตัวอย่างผลลัพธ์
{
"code": 200,
"data": null,
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}รายการไฟล์ในพื้นที่
ดึงข้อมูลรายการไฟล์ในพื้นที่ รายการจะถูกจัดเรียงตามลำดับเวลาการอัปโหลดไฟล์จากใหม่ไปเก่า
- วิธีการร้องขอ
GET- เส้นทางคำขอ
/openapi/file/list- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
page | number | ไม่ | หมายเลขหน้าของรายการ ค่าปริยายคือ 1 |
pageSize | number | ไม่ | จำนวนรายการต่อหน้า ซึ่งสามารถตั้งค่าได้ตั้งแต่ 1 ถึง 100 โดยค่าปริยายคือ 20 |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
page- ประเภทข้อมูล
number- จำเป็น
- ไม่
- คำอธิบาย
- หมายเลขหน้าของรายการ ค่าปริยายคือ 1
pageSize- ประเภทข้อมูล
number- จำเป็น
- ไม่
- คำอธิบาย
- จำนวนรายการต่อหน้า ซึ่งสามารถตั้งค่าได้ตั้งแต่ 1 ถึง 100 โดยค่าปริยายคือ 20
ตัวอย่างคำขอ
{
"space": "stardots",
"page": 1,
"pageSize": 20,
}ฟิลด์การตอบกลับ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
page | number | ใช่ | หมายเลขหน้าของรายการ ค่าปริยายคือ 1 |
pageSize | number | ใช่ | จำนวนรายการต่อหน้า ซึ่งสามารถตั้งค่าได้ตั้งแต่ 1 ถึง 100 โดยค่าปริยายคือ 20 |
totalCount | number | ใช่ | จำนวนรายการทั้งหมด |
list | array<object> | ใช่ | อาร์เรย์รายการไฟล์ |
list.name | string | ใช่ | ชื่อของไฟล์ |
list.byteSize | number | ใช่ | ขนาดของไฟล์ในหน่วยไบต์ |
list.size | string | ใช่ | ขนาดไฟล์ในรูปแบบที่อ่านง่าย |
list.uploadedAt | number | ใช่ | เวลาตราสัญลักษณ์ของการอัปโหลดไฟล์ในหน่วยวินาที โซนเวลาคือ UTC+8 |
list.url | string | ใช่ | ลิงก์เข้าถึงไฟล์ หากการเข้าถึงพื้นที่เป็นแบบส่วนตัว ค่าของฟิลด์นี้จะมีบัตรเข้าถึง ซึ่งใช้ได้ภายใน 20 วินาที |
page- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- หมายเลขหน้าของรายการ ค่าปริยายคือ 1
pageSize- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- จำนวนรายการต่อหน้า ซึ่งสามารถตั้งค่าได้ตั้งแต่ 1 ถึง 100 โดยค่าปริยายคือ 20
totalCount- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- จำนวนรายการทั้งหมด
list- ประเภทข้อมูล
array<object>- จำเป็น
- ใช่
- คำอธิบาย
- อาร์เรย์รายการไฟล์
list.name- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของไฟล์
list.byteSize- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- ขนาดของไฟล์ในหน่วยไบต์
list.size- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ขนาดไฟล์ในรูปแบบที่อ่านง่าย
list.uploadedAt- ประเภทข้อมูล
number- จำเป็น
- ใช่
- คำอธิบาย
- เวลาตราสัญลักษณ์ของการอัปโหลดไฟล์ในหน่วยวินาที โซนเวลาคือ UTC+8
list.url- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ลิงก์เข้าถึงไฟล์ หากการเข้าถึงพื้นที่เป็นแบบส่วนตัว ค่าของฟิลด์นี้จะมีบัตรเข้าถึง ซึ่งใช้ได้ภายใน 20 วินาที
ตัวอย่างผลลัพธ์
{
"code": 0,
"data": {
"list": [
{
"byteSize": 3600000,
"name": "star",
"size": "35KB",
"uploadedAt": 1723789637,
"url": "https://....."
}
],
"page": 1,
"pageSize": 10,
"totalCount": 1
},
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}บัตรเข้าถึงไฟล์
ดึงบัตรเข้าถึงสำหรับไฟล์ เมื่อการเข้าถึงพื้นที่เป็นแบบส่วนตัว คุณจะต้องใช้บัตรเข้าถึงในการเข้าถึงไฟล์ภายใต้พื้นที่นั้น มิฉะนั้นคำขอจะถูกปฏิเสธ
- วิธีการร้องขอ
POST- เส้นทางคำขอ
/openapi/file/ticket- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
filename | string | ใช่ | ชื่อของไฟล์ |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
filename- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของไฟล์
ตัวอย่างคำขอ
{
"filename": "1.jpg",
"space": "stardots"
}ฟิลด์การตอบกลับ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
ticket | string | ใช่ | บัตรเข้าถึง |
ticket- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- บัตรเข้าถึง
ตัวอย่างผลลัพธ์
{
"code": 200,
"data": {
"ticket": "a312.."
},
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}อัปโหลดไฟล์
อัปโหลดไฟล์ไปยังพื้นที่ โปรดทราบว่าคำขอนี้ต้องการให้คุณเริ่มคำขอในรูปแบบของฟอร์ม
- วิธีการร้องขอ
PUT- เส้นทางคำขอ
/openapi/file/upload- ประเภทเนื้อหาคำขอ
multipart/form-data- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
file | binary | ใช่ | สตรีมไบนารีของไฟล์ โปรดทราบว่า ชื่อไฟล์ต้องไม่เกิน 170 ตัวอักษร ขนาดไฟล์ต้องไม่เกิน 10MB |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
file- ประเภทข้อมูล
binary- จำเป็น
- ใช่
- คำอธิบาย
- สตรีมไบนารีของไฟล์ โปรดทราบว่า ชื่อไฟล์ต้องไม่เกิน 170 ตัวอักษร ขนาดไฟล์ต้องไม่เกิน 10MB
ฟิลด์การตอบกลับ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
filename | string | ใช่ | ชื่อของไฟล์ |
url | string | ใช่ | ลิงก์การเข้าถึงของไฟล์ หากการเข้าถึงพื้นที่เป็นแบบส่วนตัว ลิงก์การเข้าถึงจะมีบัตรเข้าถึง |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
filename- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของไฟล์
url- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ลิงก์การเข้าถึงของไฟล์ หากการเข้าถึงพื้นที่เป็นแบบส่วนตัว ลิงก์การเข้าถึงจะมีบัตรเข้าถึง
ตัวอย่างผลลัพธ์
{
"code": 200,
"data": {
"filename": "1.png",
"space": "space",
"url": "https://i.stardots.io/space/1.png"
},
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}ลบไฟล์
ลบไฟล์ในพื้นที่ อินเทอร์เฟซนี้รองรับการดำเนินการแบบกลุ่ม
- วิธีการร้องขอ
DELETE- เส้นทางคำขอ
/openapi/file/delete- ประเภทเนื้อหาคำขอ
application/json- ประเภทเนื้อหาผลลัพธ์
application/json
พารามิเตอร์คำขอ
| ชื่อ | ประเภทข้อมูล | จำเป็น | คำอธิบาย |
|---|---|---|---|
space | string | ใช่ | ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร |
filenameList | array<string> | ใช่ | อาร์เรย์ของชื่อไฟล์ |
space- ประเภทข้อมูล
string- จำเป็น
- ใช่
- คำอธิบาย
- ชื่อของพื้นที่ ซึ่งสามารถใช้ตัวอักษรหรือตัวเลขเท่านั้น และความยาวอยู่ระหว่าง 4 ถึง 15 ตัวอักษร
filenameList- ประเภทข้อมูล
array<string>- จำเป็น
- ใช่
- คำอธิบาย
- อาร์เรย์ของชื่อไฟล์
ตัวอย่างคำขอ
{
"filenameList": ["1.jpg", "2.jpg"],
"space": "stardots"
}ฟิลด์การตอบกลับ
ไม่มีฟิลด์
ตัวอย่างผลลัพธ์
{
"code": 0,
"data": null,
"message": "SUCCESS",
"requestId": "5686efa5-c747-4f63-8657-e6052f8181a9",
"success": true,
"ts": 1670899688591
}รหัสการตอบกลับของเซิร์ฟเวอร์
รหัสการตอบกลับของเซิร์ฟเวอร์คือรหัสการตอบกลับที่เซิร์ฟเวอร์ส่งกลับให้กับลูกค้าเพื่อแสดงผลของการดำเนินการของเซิร์ฟเวอร์
| รหัส | คำอธิบาย |
|---|---|
200 | สำเร็จ |
504 | คำขอเกินเวลา |
999999 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ |
100000 | พารามิเตอร์คำขอไม่ถูกต้อง |
100001 | บัตรเข้าถึงหมดอายุ |
100002 | การตรวจสอบบุคคลลูกบาศก์ไม่ผ่าน |
100003 | รหัสยืนยันไม่ถูกต้อง |
100004 | บัญชีไม่มีอยู่ |
100005 | รหัสผ่านบัญชีไม่ตรง |
100006 | ระบบการสมัครเช่าไม่มีอยู่ |
100007 | การส่งข้อความ/อีเมลส่งข้อความ/อีเมลส่งข้อความมากเกินไป |
100008 | การส่งข้อความ/อีเมลส่งข้อความ/อีเมลส่งข้อความมากเกินไป |
100009 | พื้นที่/พื้นที่จัดเก็บไม่มีอยู่ |
100010 | พื้นที่/พื้นที่จัดเก็บมีอยู่แล้ว |
100011 | พื้นที่/พื้นที่จัดเก็บไม่ว่าง |
100012 | การดำเนินการมากเกินไป |
100013 | พื้นที่/พื้นที่จัดเก็บจำนวนคูปองมีอยู่แล้ว |
100014 | จำนวนไฟล์มีอยู่แล้ว |
100015 | คูปองการถ่ายโอนของกระสับกระส่ายมีอยู่แล้ว |
100016 | ระบบการสมัครเช่าไม่ตรง |
100017 | พื้นที่/พื้นที่จัดเก็บไฟล์การเข้าถึงถูกจำกัด |
100018 | ไฟล์มีขนาดใหญ่เกินไป |
100019 | รูปแบบไฟล์ไม่ถูกต้อง |
100020 | Referer ไม่อนุญาต |
100021 | ฟังก์ชันมีอยู่เฉพาะสำหรับผู้ใช้ Pro หรือ Premium |
100022 | ฟังก์ชันมีอยู่เฉพาะสำหรับผู้ใช้ Premium |
100023 | เนื้อหาหนังสือรับรองไม่ถูกต้อง |
100024 | หนังสือรับรองและคีย์ส่วนตัวไม่ตรง |
100025 | ประเภท MIME รูปภาพไม่ถูกต้อง |
100026 | ลิงก์การเข้าถึงไฟล์ถูกลบ |
100027 | จำนวนการเรียก API ได้ถึงขีดจำกัด |
100028 | การดำเนินการกลุ่มมีอยู่เฉพาะสำหรับผู้ใช้บริการจ่ายเงิน |
100029 | ลิงก์รูปภาพไม่ถูกต้อง |
100030 | บัญชีถูกกล่าวเป็นผู้กรอกเงินผิดกฎหมาย ถูกบังคับห้ามเข้าสู่ระบบ |
200- คำอธิบาย
- สำเร็จ
504- คำอธิบาย
- คำขอเกินเวลา
999999- คำอธิบาย
- ข้อผิดพลาดภายในเซิร์ฟเวอร์
100000- คำอธิบาย
- พารามิเตอร์คำขอไม่ถูกต้อง
100001- คำอธิบาย
- บัตรเข้าถึงหมดอายุ
100002- คำอธิบาย
- การตรวจสอบบุคคลลูกบาศก์ไม่ผ่าน
100003- คำอธิบาย
- รหัสยืนยันไม่ถูกต้อง
100004- คำอธิบาย
- บัญชีไม่มีอยู่
100005- คำอธิบาย
- รหัสผ่านบัญชีไม่ตรง
100006- คำอธิบาย
- ระบบการสมัครเช่าไม่มีอยู่
100007- คำอธิบาย
- การส่งข้อความ/อีเมลส่งข้อความ/อีเมลส่งข้อความมากเกินไป
100008- คำอธิบาย
- การส่งข้อความ/อีเมลส่งข้อความ/อีเมลส่งข้อความมากเกินไป
100009- คำอธิบาย
- พื้นที่/พื้นที่จัดเก็บไม่มีอยู่
100010- คำอธิบาย
- พื้นที่/พื้นที่จัดเก็บมีอยู่แล้ว
100011- คำอธิบาย
- พื้นที่/พื้นที่จัดเก็บไม่ว่าง
100012- คำอธิบาย
- การดำเนินการมากเกินไป
100013- คำอธิบาย
- พื้นที่/พื้นที่จัดเก็บจำนวนคูปองมีอยู่แล้ว
100014- คำอธิบาย
- จำนวนไฟล์มีอยู่แล้ว
100015- คำอธิบาย
- คูปองการถ่ายโอนของกระสับกระส่ายมีอยู่แล้ว
100016- คำอธิบาย
- ระบบการสมัครเช่าไม่ตรง
100017- คำอธิบาย
- พื้นที่/พื้นที่จัดเก็บไฟล์การเข้าถึงถูกจำกัด
100018- คำอธิบาย
- ไฟล์มีขนาดใหญ่เกินไป
100019- คำอธิบาย
- รูปแบบไฟล์ไม่ถูกต้อง
100020- คำอธิบาย
- Referer ไม่อนุญาต
100021- คำอธิบาย
- ฟังก์ชันมีอยู่เฉพาะสำหรับผู้ใช้ Pro หรือ Premium
100022- คำอธิบาย
- ฟังก์ชันมีอยู่เฉพาะสำหรับผู้ใช้ Premium
100023- คำอธิบาย
- เนื้อหาหนังสือรับรองไม่ถูกต้อง
100024- คำอธิบาย
- หนังสือรับรองและคีย์ส่วนตัวไม่ตรง
100025- คำอธิบาย
- ประเภท MIME รูปภาพไม่ถูกต้อง
100026- คำอธิบาย
- ลิงก์การเข้าถึงไฟล์ถูกลบ
100027- คำอธิบาย
- จำนวนการเรียก API ได้ถึงขีดจำกัด
100028- คำอธิบาย
- การดำเนินการกลุ่มมีอยู่เฉพาะสำหรับผู้ใช้บริการจ่ายเงิน
100029- คำอธิบาย
- ลิงก์รูปภาพไม่ถูกต้อง
100030- คำอธิบาย
- บัญชีถูกกล่าวเป็นผู้กรอกเงินผิดกฎหมาย ถูกบังคับห้ามเข้าสู่ระบบ
SDK
StarDots มี SDK สำหรับภาษาโปรแกรมมิ่งต่างๆ เพื่อช่วยให้คุณสามารถผสานรวมกับ API ของเราได้อย่างรวดเร็ว คุณสามารถค้นหา SDK ได้จากลิงก์ต่อไปนี้:
GoJavaC#PythonTypescriptC++RustPHPRubyVSwiftKotlinDart