Обзор архитектуры REST API
Спецификация OpenAPI 3.1, базовые адреса, заголовки и единый формат JSON-ответов.
API платформы SmallPict построено на принципах RESTful и спецификации OpenAPI 3.1. Оно обеспечивает детерминированное время отклика и предсказуемую структуру JSON.
Базовые адреса сервиса
| Среда | Базовый URL | Назначение |
|---|---|---|
| Рабочая (Production) | https://api.smallpict.app/v1 | Боевой трафик приложений (расходует тарифную квоту). |
| Песочница (Sandbox) | https://api.smallpict.app/v1 | Локальные тесты и CI/CD с ключами sp_test_... (бесплатно). |
Основные эндпоинты
| Метод | Эндпоинт | Назначение |
|---|---|---|
POST | /optimize | Синхронная или асинхронная оптимизация и транскодирование. |
GET | /status/{job_id} | Проверка статуса выполнения задачи в очереди. |
GET | /quota | Получение информации о тарифе, остатке квоты и потреблении. |
POST | /purge | Моментальное удаление файлов из кэша SmallPict Edge CDN. |
Формат 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" }}