ภาพรวมของ REST API
ข้อกำหนด OpenAPI 3.1, URL พื้นฐาน, ส่วนหัว HTTP และโครงสร้างผลลัพธ์ JSON
API ของ SmallPict พัฒนาขึ้นตามหลักการ RESTful และสอดคล้องกับมาตรฐาน OpenAPI 3.1 ให้เวลาตอบสนองที่แม่นยำและโครงสร้าง JSON ที่เป็นมาตรฐานสากล
URL บริการพื้นฐาน
| สภาพแวดล้อม | URL พื้นฐาน | วัตถุประสงค์ |
|---|---|---|
| ระบบจริง (Production) | https://api.smallpict.app/v1 | ใช้งานจริงสำหรับแอปพลิเคชัน (หักโควตารายเดือน) |
| ระบบทดสอบ (Sandbox) | https://api.smallpict.app/v1 | พัฒนาและทดสอบ CI/CD ด้วยคีย์ sp_test_... (ฟรี) |
เอนด์พอยต์หลัก
| เมธอด | เอนด์พอยต์ | หน้าที่การทำงาน |
|---|---|---|
POST | /optimize | ประมวลผลและแปลงไฟล์รูปภาพแบบซิงโครนัสหรือในเบื้องหลัง |
GET | /status/{job_id} | ตรวจสอบสถานะของงานประมวลผลที่อยู่ในคิว |
GET | /quota | ตรวจสอบรายละเอียดแพ็กเกจ ยอดคงเหลือ และสถิติการใช้งาน |
POST | /purge | สั่งลบไฟล์ออกจากแคชของ SmallPict CDN ทันที |
รูปแบบคำตอบ JSON มาตรฐาน
Response · 200 OK
{ "success": true, "data": { "job_id": "job_1a2b3c4d5e6f", "status": "completed", "original_size": 2048500, "optimized_size": 256100, "savings_percentage": 87.49, "format": "avif", "url": "https://cdn.smallpict.app/media/hero.avif" }}