Przegląd interfejsu REST API
Specyfikacja techniczna OpenAPI 3.1, bazowe URL-e, nagłówki i struktura odpowiedzi JSON.
API platformy SmallPict zostało zaprojektowane zgodnie ze standardami RESTful i specyfikacją OpenAPI 3.1, zapewniając przewidywalny czas reakcji i jednolitą strukturę JSON.
Adresy bazowe usług
| Środowisko | Bazowy URL | Zastosowanie |
|---|---|---|
| Produkcja | https://api.smallpict.app/v1 | Aplikacje działające produkcyjnie (pomniejsza miesięczny limit). |
| Sandbox | https://api.smallpict.app/v1 | Lokalne testy i CI/CD z kluczami sp_test_... (bezpłatnie). |
Główne punkty końcowe
| Metoda | Punkt końcowy | Opis |
|---|---|---|
POST | /optimize | Optymalizacja i konwersja obrazu synchronicznie lub w tle. |
GET | /status/{job_id} | Sprawdzenie statusu asynchronicznego zadania w kolejce. |
GET | /quota | Pobranie danych planu, pozostałego salda oraz zużycia. |
POST | /purge | Wyczyszczenie wskazanych adresów z pamięci podręcznej CDN. |
Standardowa struktura odpowiedzi 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" }}