Panoramica dell'API REST
Specifica tecnica OpenAPI 3.1, URL di base, intestazioni e struttura risposte JSON.
L'API di SmallPict segue gli standard architetturali RESTful e la specifica OpenAPI 3.1. Garantisce tempi di risposta affidabili e formati JSON omogenei.
URL di servizio
| Ambiente | URL Base | Utilizzo |
|---|---|---|
| Produzione | https://api.smallpict.app/v1 | Carichi di lavoro applicativi reali (consuma quota). |
| Sandbox | https://api.smallpict.app/v1 | Sviluppo e test CI/CD con chiavi sp_test_... (gratuito). |
Endpoint principali
| Metodo | Endpoint | Funzione |
|---|---|---|
POST | /optimize | Elabora e transcodifica immagini in modo sincrono o asincrono. |
GET | /status/{job_id} | Verifica l'avanzamento di un processo in coda. |
GET | /quota | Consulta il piano attivo, il saldo residuo e i consumi. |
POST | /purge | Invalida le risorse archiviate nella cache Edge di SmallPict. |
Struttura standard delle risposte 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" }}