نظرة عامة على واجهة REST API
المواصفات التقنية وفق OpenAPI 3.1، الروابط الأساسية، الترويسات وهيكل استجابات JSON.
صُممت واجهة SmallPict وفق مبادئ هندسة RESTful ومواصفات OpenAPI 3.1 القياسية، لتضمن أوقات استجابة سريعة ومخرجات JSON موحدة.
الروابط الأساسية للخدمة
| البيئة | الرابط الأساسي | الغرض من الاستخدام |
|---|---|---|
| الإنتاج (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" }}