Visão geral da REST API
Especificação técnica, endpoints base, cabeçalhos HTTP e padrões de resposta JSON.
A API do SmallPict é baseada nos princípios REST e compatível com a especificação OpenAPI 3.1. Oferece respostas ágeis e previsíveis em formato JSON padrão.
URLs base de serviço
| Ambiente | URL Base | Finalidade |
|---|---|---|
| Produção | https://api.smallpict.app/v1 | Cargas de trabalho em produção (consome cotas). |
| Sandbox | https://api.smallpict.app/v1 | Testes locais e CI/CD com chaves sp_test_... (gratuito). |
Endpoints principais
| Método | Endpoint | Descrição |
|---|---|---|
POST | /optimize | Otimiza e transcodifica imagens de forma síncrona ou assíncrona. |
GET | /status/{job_id} | Consulta o andamento de um processamento em fila. |
GET | /quota | Consulta o plano contratado, saldo restante e métricas. |
POST | /purge | Invalida arquivos em cache na rede de borda SmallPict CDN. |
Padrão de respostas 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" }}