Visión general de la REST API
Especificación técnica, endpoints base, cabeceras y estructura de respuestas JSON.
La API de SmallPict está construida bajo los principios RESTful y la especificación OpenAPI 3.1. Proporciona endpoints altamente optimizados con tiempos de respuesta predecibles y respuestas codificadas en JSON estándar.
URLs base de servicio
| Entorno | URL Base | Propósito |
|---|---|---|
| Producción | https://api.smallpict.app/v1 | Cargas de trabajo en producción (consume cuota mensual). |
| Sandbox | https://api.smallpict.app/v1 | Pruebas locales y CI/CD con claves sp_test_... (sin costo). |
Endpoints principales
| Método | Endpoint | Descripción |
|---|---|---|
POST | /optimize | Optimiza y transcodifica un archivo de imagen síncrona o asíncronamente. |
GET | /status/{job_id} | Consulta el estado de procesamiento de una tarea asíncrona en cola. |
GET | /quota | Recupera el saldo de cuota actual, plan contratado y métricas de uso. |
POST | /purge | Invalida URLs específicas en la red perimetral de SmallPict CDN. |
Formato estándar de respuesta JSON
Todas las respuestas de la API utilizan un contenedor JSON coherente:
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" }}