Vue d'ensemble de l'API REST
Spécification OpenAPI 3.1, URLs de service, en-têtes et format des réponses JSON.
L'API de SmallPict respecte les normes d'architecture RESTful et s'aligne sur la spécification OpenAPI 3.1. Elle garantit des temps de traitement prévisibles et un format JSON unifié.
URLs de service
| Environnement | URL de base | Utilisation |
|---|---|---|
| Production | https://api.smallpict.app/v1 | Trafic applicatif en production (consomme le forfait). |
| Sandbox | https://api.smallpict.app/v1 | Tests locaux et CI/CD avec clés sp_test_... (gratuit). |
Principaux points d'accès
| Méthode | Point d'accès | Rôle |
|---|---|---|
POST | /optimize | Optimise et transcode un média de façon synchrone ou asynchrone. |
GET | /status/{job_id} | Consulte l'avancement d'un traitement en file d'attente. |
GET | /quota | Récupère le plan en cours, le solde disponible et la consommation. |
POST | /purge | Purge des ressources du cache Edge de SmallPict CDN. |
Format standard des réponses 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" }}