API-Dokumentation - Vollstaendige Komprimierungsschnittstellen-Beschreibung

Vollstaendige OpenAPI 3.0-Spezifikationsdokumentation der SmartSlim-Komprimierungs-API mit allen Schnittstellenbeschreibungen, Parameterdefinitionen, Fehlercode-Referenzen und Ratenlimit-Strategien

Authentifizierungsmethode

Die SmartSlim-Komprimierungs-API verwendet Bearer Token zur Authentifizierung

Bearer Token

Der API Key wird ueber den HTTP-Request-Header Authorization uebertragen, im Format Bearer YOUR_API_KEY. Alle Schnittstellenanfragen muessen diesen Header enthalten. Bei Fehlen oder Ungueltigkeit wird ein 401-Fehler zurueckgegeben.

Uebertragungssicherheit

Alle API-Anfragen werden ueber HTTPS verschluesselt uebertragen. Verwenden Sie nicht das HTTP-Klartextprotokoll, um die Sicherheit des API Keys und der Dateidaten waehrend der Uebertragung zu gewaehrleisten.

API Key-Verwaltung

Der API Key kann in der Anwendungsverwaltung der Entwicklerkonsole eingesehen, zurueckgesetzt und deaktiviert werden. Wir empfehlen, fuer verschiedene Umgebungen (Entwicklung/Test/Produktion) separate Anwendungen zu erstellen, um Isolierung und Auditierung zu ermoeglichen.

# Authentifizierungs-Header-Beispiel
Authorization: Bearer YOUR_API_KEY

Schnittstellenliste

Die SmartSlim-Komprimierungs-API bietet vollstaendige Schnittstellen fuer Dateikomprimierung, Aufgabenverwaltung, Stapelverarbeitung und Nutzungstatistiken

POST /v1/compress

Dateikomprimierung: Laedt eine einzelne Datei hoch und fuehrt die Komprimierung aus.

file (erforderlich): Zu komprimierende Datei
quality: Komprimierungsqualitaet, Optionen: low / medium / high
format: Ausgabeformat
password (optional): Passwort fuer verschluesselte Komprimierung

GET /v1/tasks/{task_id}

Aufgabenstatus abfragen: Ruft den aktuellen Status und Ergebnisinformationen einer Komprimierungsaufgabe anhand der Aufgaben-ID ab.

Gibt status zurueck: pending / processing / completed / failed

GET /v1/tasks/{task_id}/download

Komprimierte Datei herunterladen: Nach Abschluss der Aufgabe kann die komprimierte Ergebnisdatei ueber diese Schnittstelle heruntergeladen werden. Gibt einen Dateistream zurueck.

POST /v1/batch/compress

Stapelkomprimierung: Laedt mehrere Dateien gleichzeitig fuer die Stapelkomprimierung hoch.

files[] (erforderlich): Array der zu komprimierenden Dateien
quality: Komprimierungsqualitaet
format: Ausgabeformat
callback_url (optional): Callback-URL nach Aufgabenabschluss

GET /v1/usage

Nutzungsstatistiken abfragen: Ruft die Nutzungsdaten des aktuellen Kontos ab, einschliesslich Aufrufe diesen Monat, Gesamtkomprimierungsdateimenge, Speichernutzung usw.

DELETE /v1/tasks/{task_id}

Aufgabe loeschen: Loescht eine Komprimierungsaufgabe anhand der Aufgaben-ID sowie deren Ergebnisdateien und gibt Speicherplatz frei.

Anfragebeispiel fuer Dateikomprimierungsschnittstelle

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

(Datei-Binaerinhalt)
------FormBoundary
Content-Disposition: form-data; name="quality"

high
------FormBoundary
Content-Disposition: form-data; name="format"

pdf
------FormBoundary--

Antwortbeispiel fuer Aufgabenstatusabfrage

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

Fehlercode-Referenz

HTTP-Statuscodes und Bedeutungen, die beim Aufruf zurueckgegeben werden koennen, fuer die Fehlerbehebung und Ausnahmebehandlung

HTTP-Statuscode	Name	Beschreibung
200	Erfolg	Anfrage erfolgreich verarbeitet, erwartete Ergebnisdaten zurueckgegeben.
400	Ungueltige Anfrageparameter	Anfrageparameter fehlen, haben falsches Format oder ueberschreiten Grenzwerte. Bitte ueberpruefen Sie den Anfragekoerper und die Parameter.
401	API Key ungueltig oder abgelaufen	Authorization-Header fehlt, API Key ungueltig oder abgelaufen. Bitte beschaffen Sie einen neuen gueltigen Schluessel.
403	Unzureichende Berechtigungen	Der aktuelle API Key hat keinen Zugriff auf diese Ressource oder Operation. Bitte bestaetigen Sie Paketberechtigungen und Ressourcenzuordnung.
429	Anfragefrequenz ueberschritten	Die Anfragefrequenz ueberschreitet den Ratenlimit-Schwellenwert des aktuellen Pakets. Bitte verringern Sie die Aufruffrequenz oder aktualisieren Sie das Paket.
500	Interner Serverfehler	Waehrend der serverseitigen Verarbeitung ist ein Fehler aufgetreten. Bitte versuchen Sie es spaeter erneut oder kontaktieren Sie den technischen Support.
503	Service voruebergehend nicht verfuegbar	Der Service wird gewartet oder ist voruebergehend ueberlastet. Bitte versuchen Sie es spaeter erneut.

Fehlerantwort-Beispiel

{
  "error": {
    "code": 429,
    "message": "Anfragefrequenz ueberschritten, aktuelles Paketlimit: 60 Aufrufe/Minute",
    "request_id": "req_a1b2c3d4e5f6"
  }
}

Ratenlimit-Strategie

Unterschiedliche Pakete entsprechen unterschiedlichen Anfragefrequenz-Limits. Bei Ueberschreitung wird ein 429-Fehler zurueckgegeben. Bitte waehlen Sie ein geeignetes Paket basierend auf Ihrem Geschäftsvolumen

10

Kostenlose Version
Aufrufe/Minute

60

Basis-Version
Aufrufe/Minute

300

Profi-Version
Aufrufe/Minute

Unbegrenzt

Enterprise-Version
Konfigurierbar

Das Ratenlimit wird pro API Key berechnet und verwendet einen Sliding-Window-Algorithmus zur Berechnung der Anfragen pro Minute. Bei Erreichen des Limits gibt der Antwort-Header die Felder X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset zurueck, um Clients bei der Implementierung von Backoff-Retry-Strategien zu unterstuetzen.

Unterstuetzte Dateiformate

Die SmartSlim-Komprimierungs-API deckt Dokument-, Bild-, Video- und Audiodateiformate ab, um vielfaeltige Komprimierungsanforderungen zu erfuellen

Dokumentformate

PDF, OFD, DOCX, XLSX, PPTX

Bildformate

JPG, PNG, TIFF, GIF, BMP

Videoformate

MP4, AVI, MOV

Audioformate

MP3, WAV

Die unterstuetzten Komprimierungsqualitaeten, Ausgabeoptionen und Groessenbeschraenkungen koennen je nach Format variieren. Massgeblich sind die Konsole und die tatsaechliche Schnittstellenantwort. Bei Bedarf an weiteren Formaten kontaktieren Sie bitte unser Vertriebsteam fuer massgeschneiderte Loesungen.

Online-Debugger

Online API-Debugging-Tool basierend auf Swagger UI, wird in Kuerze verfuegbar sein

Visuelles Debugging

Der Online-Debugger bietet visuelle Eingabemasken fuer Schnittstellenparameter und Anfrageversand, um das Verhalten und die Antwortstruktur der Schnittstelle schnell zu ueberpruefen, ohne Code schreiben zu muessen.

OpenAPI 3.0-Spezifikation

Vollstaendige Kompatibilitaet mit der OpenAPI 3.0-Spezifikation. Unterstuetzt den Export von Spezifikationsdateien, die direkt in Postman, Apifox und andere Tools importiert werden koennen, um lokal zu debuggen.

In Kuerze verfuegbar

Der Swagger UI Online-Debugger befindet sich in Entwicklung. Nach der Verfuegbarkeit koennen Sie den vollstaendigen Debugging-Prozess direkt im Browser erleben. Bis dahin koennen Sie die Codebeispiele im Schnellstart verwenden.

Schnellstart ansehen

Jetzt API nutzen

Registrieren Sie sich fuer einen API Key und integrieren Sie die SmartSlim-Komprimierungsfaehigkeit schnell in Ihre Anwendung

Schnellstart API-Service ansehen Vertrieb kontaktieren