Documentación API - Descripción completa de interfaces de compresión
Documentación completa de la especificación OpenAPI 3.0 de la API de compresión SmartSlim, que incluye todas las descripciones de interfaces, definiciones de parámetros, referencia de códigos de error y estrategias de limitación de tasa
Método de autenticación
La API de compresión SmartSlim utiliza Bearer Token para la autenticación de identidad
Bearer Token
La API Key se transmite a través de la cabecera HTTP Authorization, con el formato Bearer YOUR_API_KEY. Todas las solicitudes de interfaz deben incluir esta cabecera; si falta o es inválida, se devolverá un error 401.
Seguridad de transmisión
Todas las solicitudes de API se transmiten cifradas a través de HTTPS. No utilice el protocolo HTTP de texto plano para llamadas, garantizando la seguridad de la API Key y los datos de archivos durante la transmisión.
Gestión de API Key
La API Key se puede ver, restablecer y deshabilitar en la gestión de aplicaciones de la consola de desarrolladores. Se recomienda crear aplicaciones independientes para diferentes entornos (desarrollo/pruebas/producción) para facilitar el aislamiento y la auditoría.
# Ejemplo de cabecera de autenticación
Authorization: Bearer YOUR_API_KEYLista de interfaces
La API de compresión SmartSlim proporciona interfaces completas para compresión de archivos, gestión de tareas, procesamiento por lotes y estadísticas de uso
POST /v1/compress
Compresión de archivos: carga un solo archivo y realiza la compresión.
file(obligatorio): archivo a comprimirquality: calidad de compresión, opciones:low/medium/highformat: formato de salidapassword(opcional): contraseña de compresión cifrada
GET /v1/tasks/{task_id}
Consultar estado de tarea: obtiene el estado actual y la información de resultados de una tarea de compresión según el ID de tarea.
- Devuelve
status:pending/processing/completed/failed
GET /v1/tasks/{task_id}/download
Descargar archivo comprimido: una vez completada la tarea, descarga el archivo de resultado de compresión a través de esta interfaz, que devuelve un flujo de archivo.
POST /v1/batch/compress
Compresión por lotes: carga múltiples archivos a la vez para procesamiento de compresión por lotes.
files[](obligatorio): array de archivos a comprimirquality: calidad de compresiónformat: formato de salidacallback_url(opcional): URL de devolución de llamada al completar la tarea
GET /v1/usage
Consultar estadísticas de uso: obtiene los datos de uso de la cuenta actual, incluyendo el número de llamadas del mes, el volumen total de archivos comprimidos, el uso de almacenamiento, etc.
DELETE /v1/tasks/{task_id}
Eliminar tarea: elimina la tarea de compresión especificada y sus archivos de resultado según el ID de tarea, liberando espacio de almacenamiento.
Ejemplo de solicitud de interfaz de compresión de archivos
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
(contenido binario del archivo)
------FormBoundary
Content-Disposition: form-data; name="quality"
high
------FormBoundary
Content-Disposition: form-data; name="format"
pdf
------FormBoundary--Ejemplo de respuesta de consulta de estado de tarea
{
"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"
}Referencia de códigos de error
Códigos de estado HTTP que pueden devolverse durante las llamadas a la interfaz y sus descripciones, para facilitar la resolución de problemas y el manejo de excepciones
Ejemplo de respuesta de error
{
"error": {
"code": 429,
"message": "Frecuencia de solicitudes excedida, el límite del plan actual es de 60 veces/minuto",
"request_id": "req_a1b2c3d4e5f6"
}
}Estrategia de limitación de tasa
Diferentes planes corresponden a diferentes límites de frecuencia de solicitudes. Si se excede el límite, se devolverá un error 429. Seleccione el plan adecuado según su volumen de negocio
10
Plan gratuito
veces/minuto
60
Plan básico
veces/minuto
300
Plan profesional
veces/minuto
Ilimitado
Plan empresarial
Configurable bajo demanda
La limitación de tasa se calcula por API Key, utilizando un algoritmo de ventana deslizante para contar las solicitudes por minuto. Cuando se activa la limitación, las cabeceras de respuesta devolverán los campos X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset, para que el cliente pueda implementar una estrategia de reintento con retroceso.
Formatos de archivo soportados
La API de compresión SmartSlim cubre múltiples formatos de archivo incluyendo documentos, imágenes, videos y audio, satisfaciendo diversas necesidades de compresión
Formatos de documento
PDF, OFD, DOCX, XLSX, PPTX
Formatos de imagen
JPG, PNG, TIFF, GIF, BMP
Formatos de video
MP4, AVI, MOV
Formatos de audio
MP3, WAV
La calidad de compresión, las opciones de salida y los límites de tamaño soportados pueden variar según el formato. Consulte la consola y la respuesta real de la interfaz para más detalles. Si necesita soporte para otros formatos, contacte con el equipo comercial para discutir soluciones personalizadas.
Depurador en línea
Herramienta de depuración de API en línea basada en Swagger UI, próximamente disponible
Depuración visual
El depurador en línea proporciona capacidad visual para completar parámetros de interfaz y enviar solicitudes, permitiendo verificar rápidamente el comportamiento de la interfaz y la estructura de respuesta sin escribir código.
Especificación OpenAPI 3.0
Cumple completamente con la especificación OpenAPI 3.0, soporta la exportación de archivos de especificación, que se pueden importar directamente a herramientas como Postman y Apifox para depuración local.
Próximamente
El depurador en línea Swagger UI está en desarrollo. Una vez disponible, podrá experimentar el proceso completo de depuración de interfaces directamente en el navegador. Mientras tanto, consulte los ejemplos de código en Inicio Rápido.
Ver Inicio RápidoComience a usar la API ahora
Registre una cuenta para obtener su API Key e integre rápidamente las capacidades de compresión SmartSlim en su aplicación