REST API अवलोकन
OpenAPI 3.1 विनिर्देश, आधार URL, HTTP हेडर और मानक JSON प्रतिक्रिया संरचना।
SmallPict API का निर्माण RESTful सिद्धांतों और OpenAPI 3.1 विनिर्देशों के अनुसार किया गया है। यह अनुमानित प्रतिक्रिया समय और सुसंगत JSON संरचना प्रदान करता है।
आधार सेवा URLs
| परिवेश | आधार URL | उपयोग |
|---|---|---|
| उत्पादन (Production) | https://api.smallpict.app/v1 | लाइव एप्लिकेशन ट्रैफ़िक (मासिक कोटा घटाता है)। |
| सैंडबॉक्स (Sandbox) | https://api.smallpict.app/v1 | sp_test_... कुंजियों के साथ परीक्षण (निःशुल्क)। |
प्रमुख एंडपॉइंट्स
| विधि | एंडपॉइंट | कार्य |
|---|---|---|
POST | /optimize | समकालिक या असमकालिक रूप से छवि को अनुकूलित और रूपांतरित करें। |
GET | /status/{job_id} | कतार में असमकालिक कार्य की प्रगति की जाँच करें। |
GET | /quota | प्लान विवरण, शेष कोटा और खपत डेटा प्राप्त करें। |
POST | /purge | SmallPict Edge कैश से फ़ाइलों को तुरंत अमान्य करें। |
मानक 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" }}