Документация API - Полный справочник API сжатия
Complete OpenAPI 3.0 спецификацию для API сжатия SmartSlim, включая все описания конечных точек, определения параметров, ссылки на коды ошибок и политики ограничения частоты
Аутентификация
The SmartSlim API сжатия uses Bearer Token authentication
Bearer Token
API Key передается через заголовок HTTP-запроса Authorization в формате Bearer YOUR_API_KEY. Все API-запросы должны включать этот заголовок; отсутствующие или недействительные ключи вернут ошибку 401.
Transport Security
Все API-запросы передаются через зашифрованные соединения HTTPS. Не используйте протокол HTTP для вызова API, это обеспечивает безопасность вашего API Key и файловых данных во время передачи.
API Key Management
API Ключи можно просматривать, сбрасывать и disabled in the Application в разделе управления Центра разработчика Console. Мы рекомендуем создавать отдельные приложения для разных сред (development/staging/production) для удобной изоляции и аудита.
# Authentication request header example
Authorization: Bearer YOUR_API_KEYСписок конечных точек
API сжатия SmartSlim предоставляет полные конечные точки для сжатия файлов, управления задачами, пакетной обработки и статистики использования
POST /v1/compress
File Compression: Upload a single file и выполнить сжатие.
file(обязательно): Файл для file to compressquality: Качество сжатия, варианты:low/medium/highformat: Формат выводаpassword(optional): Encryption password для сжатых файлов
GET /v1/tasks/{task_id}
Запрос статуса задачи: получение текущего статуса и информации о результате задачи сжатия по ее ID.
- Returns
status:pending/processing/completed/failed
GET /v1/tasks/{task_id}/download
Скачать сжатый файл: После завершения задачи скачайте файл результата сжатия через эту конечную точку. Возвращает файловый поток.
POST /v1/batch/compress
Пакетное сжатие: Загрузите несколько файлов одновременно для пакетного сжатия.
files[](required): Array файлов для compressquality: Compression qualityformat: Формат выводаcallback_url(optional): Callback URL for task completion notification
GET /v1/usage
Запрос статистики использования: Получение данных об использовании для текущего аккаунта, включая количество вызовов за этот месяц, API общий объем сжатых file данных, использование хранилища и многое другое.
DELETE /v1/tasks/{task_id}
Delete Task: Delete указанную задачу сжатия task and its result files by task ID, освобождая место в хранилище.
Пример запроса конечной точки сжатия файлов
POST /v1/compress HTTP/1.1
Host: api.uglypear.com
Authorization: Bearer YOUR_API_KEY
Content-Type: multipart/form-data; boundary=----FormBoundary
------FormBoundary
Content-Disposition: form-data; name="file"; filename="document.pdf"
Content-Type: application/pdf
(file binary content)
------FormBoundary
Content-Disposition: form-data; name="quality"
high
------FormBoundary
Content-Disposition: form-data; name="format"
pdf
------FormBoundary--Пример ответа запроса статуса задачи
{
"task_id": "task_8f3c2a1b9e7d4c5f",
"status": "completed",
"download_url": "https://api.uglypear.com/v1/tasks/task_8f3c2a1b9e7d4c5f/download",
"original_size": 5242880,
"compressed_size": 1572864,
"compression_ratio": "70.0%",
"created_at": "2026-08-05T10:00:00Z",
"completed_at": "2026-08-05T10:00:08Z"
}Справочник кодов ошибок
HTTP-коды состояния и их значения, которые могут быть возвращены при вызовах API, полезно для устранения неполадок и обработки исключений
Пример ответа с ошибкой
{
"error": {
"code": 429,
"message": "Rate limit exceeded, current plan limit is 60 requests/minute",
"request_id": "req_a1b2c3d4e5f6"
}
}Политика ограничения частоты
Разные тарифы имеют разные ограничения частоты запросов. Превышение лимита возвращает ошибку 429. Пожалуйста, выберите тариф, который подходит для вашего объема бизнеса
10
Free Plan
запросов/минуту
60
Basic Plan
запросов/минуту
300
Pro Plan
запросов/минуту
Unlimited
Enterprise Plan
Configurable on demand
Ограничение частоты измеряется по API Key, используя алгоритм скользящего окна для подсчета запросов в минуту. При ограничении частоты заголовки ответа включают поля X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset для помощи клиентам в реализации стратегий отсрочки и повторных попыток.
Supported File Formats
API сжатия SmartSlim охватывает форматы документов, изображений, видео и аудио для разнообразных потребностей сжатия
Document Formats
PDF, OFD, DOCX, XLSX, PPTX
Image Formats
JPG, PNG, TIFF, GIF, BMP
Video Formats
MP4, AVI, MOV
Audio Formats
MP3, WAV
Поддерживаемое качество сжатия, параметры вывода и ограничения размера файла могут различаться в зависимости от формата. Подробности смотрите в консоли и фактических ответах API. Чтобы запросить поддержку дополнительных форматов, свяжитесь с нашим отделом продаж для обсуждения индивидуальных решений.
Онлайн-отладчик
Онлайн-инструмент отладки API на основе Swagger UI, скоро будет доступно
Visual Debugging
Онлайн-отладчик предоставляет визуальный интерфейс для заполнения параметров конечной точки и отправки запросов, позволяя быстро проверить поведение конечной точки и структуру ответа без написания кода.
OpenAPI 3.0 Specification
Полное соответствие спецификации OpenAPI 3.0, поддержка экспорта файлов. Вы можете импортировать её напрямую в инструменты вроде Postman или Apifox для локальной отладки.
Coming Soon
The Swagger UI online debugger is under development. Once launched, you will be able to experience the complete API процесс отладки прямо в вашем браузере. Тем временем, пожалуйста, обратитесь к примерам кода в руководстве по быстрому старту.
Смотреть быстрый стартНачать использование API Нетw
Register an account to get your API Key и быстро интегрируйте SmartSlim возможности сжатия в ваше application