Démarrage rapide - Intégration de l'API de compression en 5 minutes

En quelques étapes simples, intégrez le service d'API de compression SmartSlim et utilisez curl / Python / Java / Node.js pour lancer votre première requête de compression

Étape 1 : Enregistrer un compte et obtenir une clé API

Avant de commencer à appeler l'API de compression, vous devez d'abord enregistrer un compte UGLYPEAR DATA et créer une application pour obtenir une clé API

S'inscrire sur la console

Accédez à la console développeur UGLYPEAR DATA, inscrivez-vous avec votre e-mail ou numéro de téléphone, et après avoir terminé l'authentification par nom réel, vous pouvez commencer à utiliser le service.

Créer une application

Après vous être connecté à la console, créez une nouvelle application dans « Gestion des applications », remplissez le nom de l'application, la description de l'utilisation et sélectionnez le plan de service souhaité.

Obtenir la clé API

Une fois l'application créée, le système génère une clé API unique pour cette application. Conservez-la soigneusement et ne la divulguez pas dans le code client ou les dépôts publics.

Conseil de sécurité :La clé API est équivalente à vos identifiants de compte. Veuillez la lire via des variables d'environnement ou un service de gestion des clés. Ne la codez jamais en dur dans le code source et ne la soumettez jamais à un dépôt de code.

Étape 2 : Premier appel API (curl)

Après avoir obtenu la clé API, vous pouvez utiliser curl pour lancer rapidement une requête de compression et vérifier la connectivité et la disponibilité du service

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"

Dans la requête, remplacez YOUR_API_KEY par votre clé API réelle, file=@document.pdf pointe vers le fichier local à compresser, et le paramètre quality peut être low / medium / high.

Étape 3 : Exemple de code Python

Utilisez la bibliothèque requests de Python pour télécharger un fichier et obtenir le résultat de compression, adapté à l'intégration de services backend et aux scripts de traitement de données

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"Compression terminée, lien de téléchargement : {result['download_url']}")

Étape 4 : Exemple de code Node.js

Utilisez Node.js avec form-data et fetch pour télécharger un fichier, adapté aux applications Node côté serveur et aux scénarios 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));

Étape 5 : Exemple de code Java (OkHttp)

Utilisez le client Java OkHttp pour construire une requête multipart, adapté aux backends Java d'entreprise et à l'intégration d'applications 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());
        }
    }
}

Description du format de réponse API

Après une requête de compression réussie, le serveur renvoie une réponse au format JSON, contenant l'identifiant de la tâche et les informations sur le résultat de la compression

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

L'identifiant unique de cette tâche de compression, peut être utilisé pour interroger le statut de la tâche, télécharger le fichier résultat ou supprimer la tâche.

status

Le statut de la tâche, les valeurs possibles sont pending / processing / completed / failed.

download_url

L'URL de téléchargement du fichier de résultat compressé. Une fois la tâche terminée, vous pouvez obtenir le fichier compressé via ce lien.

original_size

La taille du fichier original, en octets (Byte).

compressed_size

La taille du fichier après compression, en octets (Byte).

compression_ratio

Le taux de compression, indiquant le pourcentage de réduction de taille. Plus la valeur est élevée, meilleur est l'effet de compression.

Prochaines étapes

Après avoir effectué votre premier appel, vous pouvez explorer la documentation API complète, télécharger les SDK dans différents langages ou consulter plus d'exemples de code

Documentation API

Consultez la spécification complète de l'interface OpenAPI 3.0, les définitions des paramètres, les codes d'erreur et la stratégie de limitation de débit.

Voir la documentation API

Téléchargement SDK

Téléchargez la bibliothèque dynamique Rust SDK, les en-têtes C FFI et le package de liaison Python pour accélérer le développement de l'intégration.

Télécharger le SDK

Exemples de code

Consultez des exemples de code complets pour les scénarios typiques tels que la compression par lots, les tâches asynchrones et la compression chiffrée.

Voir les exemples

Voir la documentation API complète

Commencez à construire votre solution d'intégration de compression, consultez toutes les descriptions d'interfaces, définitions de paramètres et références de codes d'erreur

Voir la documentation API complète En savoir plus sur le service API Contacter l'équipe commerciale