Inicio Rápido - 5 minutos para integrar la API de compresión

Con unos simples pasos, puede integrar el servicio de API de compresión SmartSlim y realizar su primera solicitud de compresión con curl / Python / Java / Node.js

Paso 1: Registrar cuenta y obtener API Key

Antes de comenzar a llamar a la API de compresión, debe registrar una cuenta de UGLYPEAR DATA y crear una aplicación para obtener su API Key

Registrar en la consola

Visite la consola de desarrolladores de UGLYPEAR DATA, regístrese con correo electrónico o número de teléfono, complete la verificación de identidad real y comience a usar el servicio.

Crear aplicación

Después de iniciar sesión en la consola, cree una nueva aplicación en "Gestión de aplicaciones", complete el nombre de la aplicación, la descripción de uso y seleccione el plan de servicio deseado.

Obtener API Key

Una vez creada la aplicación, el sistema generará una API Key única para ella. Guárdela de forma segura y no la exponga en código de cliente o repositorios públicos.

Consejo de seguridad:La API Key es equivalente a su credencial de cuenta. Léala mediante variables de entorno o servicios de gestión de claves. Nunca la codifique directamente en el código fuente ni la envíe a repositorios de código.

Paso 2: Primera llamada API (curl)

Después de obtener la API Key, puede usar curl para realizar rápidamente una solicitud de compresión y verificar la conectividad y disponibilidad del servicio

curl -X POST https://api.uglypear.com/v1/compress \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@document.pdf" \
  -F "quality=high"

En la solicitud, reemplace YOUR_API_KEY con su API Key real, file=@document.pdf apunta al archivo local a comprimir, y el parámetro quality puede ser low / medium / high.

Paso 3: Código de ejemplo Python

Use la librería requests de Python para cargar archivos y obtener resultados de compresión, ideal para integración de servicios backend y scripts de procesamiento de datos

import requests

url = "https://api.uglypear.com/v1/compress"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
files = {"file": open("document.pdf", "rb")}
data = {"quality": "high", "format": "pdf"}

response = requests.post(url, headers=headers, files=files, data=data)
result = response.json()
print(f"Compresión completada, enlace de descarga: {result['download_url']}")

Paso 4: Código de ejemplo Node.js

Use Node.js con form-data y fetch para cargar archivos, adecuado para aplicaciones Node del lado del servidor y escenarios Serverless

const FormData = require('form-data');
const fs = require('fs');

const form = new FormData();
form.append('file', fs.createReadStream('document.pdf'));
form.append('quality', 'high');

fetch('https://api.uglypear.com/v1/compress', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer YOUR_API_KEY', ...form.getHeaders() },
  body: form
}).then(res => res.json()).then(data => console.log(data));

Paso 5: Código de ejemplo Java (OkHttp)

Use el cliente OkHttp de Java para construir una solicitud multipart, adecuada para backends Java empresariales e integración de aplicaciones Android

import okhttp3.*;
import java.io.File;

public class CompressDemo {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        File file = new File("document.pdf");
        RequestBody body = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("file", file.getName(),
                        RequestBody.create(file, MediaType.parse("application/pdf")))
                .addFormDataPart("quality", "high")
                .build();

        Request request = new Request.Builder()
                .url("https://api.uglypear.com/v1/compress")
                .addHeader("Authorization", "Bearer YOUR_API_KEY")
                .post(body)
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println(response.body().string());
        }
    }
}

Descripción del formato de respuesta API

Tras una solicitud de compresión exitosa, el servidor devuelve una respuesta en formato JSON que contiene el identificador de la tarea y la información del resultado de compresión

{
  "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%"
}

task_id

Identificador único de la tarea de compresión, que se puede usar para consultar el estado de la tarea, descargar el archivo de resultados o eliminar la tarea.

status

Estado de la tarea, los valores posibles son pending / processing / completed / failed.

download_url

URL de descarga del archivo de resultado de compresión. Una vez completada la tarea, puede obtener el archivo comprimido a través de este enlace.

original_size

Tamaño del archivo original, en bytes (Byte).

compressed_size

Tamaño del archivo comprimido, en bytes (Byte).

compression_ratio

Ratio de compresión, que indica el porcentaje de reducción de tamaño. Cuanto mayor sea el valor, mejor será el efecto de compresión.

Siguientes pasos

Después de completar la primera llamada, puede profundizar en la documentación completa de la API, descargar los SDK de varios lenguajes o ver más ejemplos de código

Documentación API

Consulte la especificación completa de interfaz OpenAPI 3.0, definiciones de parámetros, códigos de error y estrategias de limitación de tasa.

Ver documentación API

Descarga SDK

Descargue la librería dinámica Rust SDK, los archivos de cabecera C FFI y el paquete de enlace Python para acelerar el desarrollo de la integración.

Descargar SDK

Ejemplos de código

Vea ejemplos de código completos para escenarios típicos como compresión por lotes, tareas asíncronas y compresión cifrada.

Ver ejemplos

Ver la documentación completa de la API

Comience a construir su solución de integración de compresión, consulte todas las descripciones de interfaces, definiciones de parámetros y referencia de códigos de error

Ver documentación completa de la API Conocer el servicio API Consultar comercial