Schnellstart - Komprimierungs-API in 5 Minuten integrieren

Mit wenigen einfachen Schritten können Sie den SmartSlim-Komprimierungs-API-Service integrieren und Ihre erste Komprimierungsanfrage mit curl / Python / Java / Node.js starten

Schritt 1: Konto registrieren und API Key erhalten

Bevor Sie die Komprimierungs-API aufrufen können, müssen Sie ein UGLYPEAR DATA-Konto registrieren und eine Anwendung erstellen, um Ihren API Key zu erhalten

Zur Konsole registrieren

Besuchen Sie die UGLYPEAR DATA-Entwicklerkonsole, registrieren Sie sich mit E-Mail oder Telefonnummer und schließen Sie die Identitätsverifizierung ab, um den Service zu nutzen.

Anwendung erstellen

Nach der Anmeldung erstellen Sie in der "Anwendungsverwaltung" eine neue Anwendung, geben den Anwendungsnamen und Verwendungszweck ein und wählen das gewünschte Service-Paket.

API Key erhalten

Nach dem Erstellen der Anwendung generiert das System einen eindeutigen API Key. Bewahren Sie diesen sicher auf und leaken Sie ihn nicht im Client-Code oder in öffentlichen Repositories.

Sicherheitshinweis:Der API Key entspricht Ihren Kontoanmeldedaten. Bitte lesen Sie ihn über Umgebungsvariablen oder einen Secret-Management-Service ein. Hartkodieren Sie ihn nicht im Quellcode und laden Sie ihn nicht in Code-Repositories hoch.

Schritt 2: Erster API-Aufruf (curl)

Nachdem Sie den API Key erhalten haben, können Sie mit curl schnell eine Komprimierungsanfrage senden, um die Konnektivität und Serviceverfügbarkeit zu überprüfen

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"

Ersetzen Sie in der Anfrage YOUR_API_KEY durch Ihren tatsächlichen API Key, file=@document.pdf verweist auf die zu komprimierende lokale Datei, und der Parameter quality kann low / medium / high sein.

Schritt 3: Python-Beispielcode

Verwenden Sie die Python requests-Bibliothek, um eine Datei hochzuladen und das Komprimierungsergebnis zu erhalten - ideal für Backend-Service-Integration und Datenverarbeitungsskripte

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"Komprimierung abgeschlossen, Download-Link: {result['download_url']}")

Schritt 4: Node.js-Beispielcode

Verwenden Sie Node.js mit form-data und fetch, um Dateien hochzuladen - geeignet für serverseitige Node-Anwendungen und Serverless-Szenarien

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));

Schritt 5: Java-Beispielcode (OkHttp)

Verwenden Sie den Java OkHttp-Client, um eine multipart-Anfrage zu erstellen - geeignet für Enterprise-Java-Backends und Android-App-Integration

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());
        }
    }
}

API-Antwortformat

Nach einer erfolgreichen Komprimierungsanfrage gibt der Server eine JSON-formatierte Antwort zurück, die die Aufgabenkennung und Komprimierungsergebnisinformationen enthält

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

Eindeutige Kennung dieser Komprimierungsaufgabe. Kann verwendet werden, um den Aufgabenstatus abzufragen, Ergebnisdateien herunterzuladen oder die Aufgabe zu löschen.

status

Aufgabenstatus, mögliche Werte: pending / processing / completed / failed.

download_url

Download-URL der komprimierten Ergebnisdatei. Nach Abschluss der Aufgabe kann die komprimierte Datei über diesen Link abgerufen werden.

original_size

Ursprüngliche Dateigröße in Bytes.

compressed_size

Komprimierte Dateigröße in Bytes.

compression_ratio

Komprimierungsrate, die den prozentualen Volumenrückgang angibt. Ein höherer Wert bedeutet eine bessere Komprimierung.

Weitere Schritte

Nach dem ersten Aufruf können Sie die vollständige API-Dokumentation lesen, SDKs für verschiedene Sprachen herunterladen oder weitere Codebeispiele ansehen

API-Dokumentation

Konsultieren Sie die vollständige OpenAPI 3.0-Spezifikation, Parameterdefinitionen, Fehlercodes und Ratenlimit-Strategien.

API-Dokumentation ansehen

SDK-Download

Laden Sie die Rust SDK dynamische Bibliothek, C FFI-Headerdateien und Python-Bindings herunter, um die Integration zu beschleunigen.

SDK herunterladen

Codebeispiele

Vollständige Beispielcodes für typische Szenarien wie Stapelkomprimierung, asynchrone Aufgaben und verschlüsselte Komprimierung.

Beispiele ansehen

Vollständige API-Dokumentation ansehen

Beginnen Sie mit der Integration Ihrer Komprimierungslösung und konsultieren Sie alle Schnittstellenbeschreibungen, Parameterdefinitionen und Fehlercode-Referenzen

Vollständige API-Dokumentation ansehen API-Service ansehen Vertrieb kontaktieren