Documentation API - Description complète de l'interface de compression

Documentation complète de la spécification OpenAPI 3.0 de l'API de compression SmartSlim, incluant toutes les descriptions d'interfaces, définitions de paramètres, références de codes d'erreur et stratégies de limitation de débit

Méthode d'authentification

L'API de compression SmartSlim utilise l'authentification Bearer Token

Bearer Token

La clé API est transmise via l'en-tête HTTP Authorization, au format Bearer YOUR_API_KEY. Toutes les requêtes d'interface doivent inclure cet en-tête. S'il est manquant ou invalide, une erreur 401 sera renvoyée.

Sécurité de transmission

Toutes les requêtes API sont transmises via HTTPS chiffré. N'utilisez pas le protocole HTTP en clair pour les appels, afin de garantir la sécurité de la clé API et des données de fichiers pendant la transmission.

Gestion des clés API

Les clés API peuvent être consultées, réinitialisées et désactivées dans la gestion des applications de la console développeur. Il est recommandé de créer des applications distinctes pour différents environnements (développement/test/production) pour faciliter l'isolation et l'audit.

# Exemple d'en-tête d'authentification
Authorization: Bearer YOUR_API_KEY

Liste des interfaces

L'API de compression SmartSlim fournit des interfaces complètes pour la compression de fichiers, la gestion des tâches, le traitement par lots et les statistiques d'utilisation

POST /v1/compress

Compression de fichiers : téléchargez un seul fichier et exécutez la compression.

file (obligatoire) : fichier à compresser
quality : qualité de compression, options low / medium / high
format : format de sortie
password (facultatif) : mot de passe de compression chiffrée

GET /v1/tasks/{task_id}

Interroger le statut de la tâche : obtenez le statut actuel et les informations de résultat d'une tâche de compression selon l'ID de tâche.

Retourne status : pending / processing / completed / failed

GET /v1/tasks/{task_id}/download

Télécharger le fichier compressé : une fois la tâche terminée, téléchargez le fichier de résultat compressé via cette interface, qui renvoie un flux de fichiers.

POST /v1/batch/compress

Compression par lots : téléchargez plusieurs fichiers à la fois pour un traitement de compression par lots.

files[] (obligatoire) : tableau de fichiers à compresser
quality : qualité de compression
format : format de sortie
callback_url (facultatif) : URL de rappel à la fin de la tâche

GET /v1/usage

Interroger les statistiques d'utilisation : obtenez les données d'utilisation du compte actuel, y compris le nombre d'appels ce mois-ci, le volume total de fichiers compressés, l'utilisation du stockage, etc.

DELETE /v1/tasks/{task_id}

Supprimer la tâche : supprimez la tâche de compression spécifiée et son fichier résultat selon l'ID de tâche, libérant ainsi l'espace de stockage.

Exemple de requête de l'interface de compression de fichiers

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

(contenu binaire du fichier)
------FormBoundary
Content-Disposition: form-data; name="quality"

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

pdf
------FormBoundary--

Exemple de réponse de requête de statut de tâche

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

Référence des codes d'erreur

Codes d'état HTTP et leurs significations pouvant être renvoyés lors des appels d'interface, facilitant le dépannage et la gestion des exceptions

Code d'état HTTP	Nom	Description
200	Succès	La requête a été traitée avec succès, renvoyant les données de résultat attendues.
400	Erreur de paramètres de requête	Paramètres de requête manquants, format incorrect ou hors limites. Veuillez vérifier le corps de la requête et les paramètres.
401	Clé API invalide ou expirée	En-tête Authorization manquant, clé API invalide ou expirée. Veuillez obtenir une nouvelle clé valide.
403	Permissions insuffisantes	La clé API actuelle n'a pas accès à cette ressource ou opération. Veuillez vérifier les permissions du plan et l'appartenance de la ressource.
429	Fréquence de requêtes dépassée	La fréquence des requêtes dépasse le seuil de limitation de débit du plan actuel. Veuillez réduire la fréquence d'appel ou mettre à niveau le plan.
500	Erreur interne du serveur	Une exception s'est produite lors du traitement côté serveur. Veuillez réessayer plus tard ou contacter le support technique.
503	Service temporairement indisponible	Le service est en maintenance ou temporairement surchargé. Veuillez réessayer plus tard.

Exemple de réponse d'erreur

{
  "error": {
    "code": 429,
    "message": "Fréquence de requêtes dépassée, la limite du plan actuel est de 60 requêtes/minute",
    "request_id": "req_a1b2c3d4e5f6"
  }
}

Stratégie de limitation de débit

Différents plans correspondent à différentes limites de fréquence de requêtes. Le dépassement renvoie une erreur 429. Veuillez choisir un plan adapté à votre volume d'activité

10

Version gratuite
requêtes/minute

60

Version de base
requêtes/minute

300

Version professionnelle
requêtes/minute

Illimité

Version entreprise
Configuration à la demande

La limitation de débit est calculée par clé API, en utilisant un algorithme de fenêtre glissante pour compter le nombre de requêtes par minute. Lorsque la limite est atteinte, les en-têtes de réponse incluent les champs X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset, permettant aux clients d'implémenter une stratégie de réessai avec backoff.

Formats de fichiers pris en charge

L'API de compression SmartSlim couvre plusieurs catégories de formats de fichiers, notamment documents, images, vidéos et audio, pour répondre à divers besoins de compression

Formats de documents

PDF, OFD, DOCX, XLSX, PPTX

Formats d'images

JPG, PNG, TIFF, GIF, BMP

Formats vidéo

MP4, AVI, MOV

Formats audio

MP3, WAV

La qualité de compression, les options de sortie et les limites de taille prises en charge peuvent varier selon les formats. Pour plus de détails, reportez-vous à la console et aux réponses réelles de l'interface. Pour prendre en charge d'autres formats, veuillez contacter l'équipe commerciale pour discuter d'une solution personnalisée.

Débogueur en ligne

Outil de débogage d'API en ligne basé sur Swagger UI, bientôt disponible

Débogage visuel

Le débogueur en ligne offre une capacité visuelle de saisie des paramètres d'interface et d'envoi de requêtes, permettant de vérifier rapidement le comportement de l'interface et la structure de réponse sans écrire de code.

Spécification OpenAPI 3.0

Conforme à la spécification OpenAPI 3.0, prend en charge l'exportation du fichier de spécification, qui peut être importé directement dans Postman, Apifox et autres outils pour le débogage local.

Bientôt disponible

Le débogueur en ligne Swagger UI est en cours de développement. Une fois en ligne, vous pourrez expérimenter le flux complet de débogage d'interface directement dans le navigateur. En attendant, vous pouvez consulter les exemples de code dans le guide de démarrage rapide.

Voir le démarrage rapide

Commencez à utiliser l'API dès maintenant

Enregistrez un compte pour obtenir une clé API et intégrez rapidement la capacité de compression SmartSlim dans votre application

Démarrage rapide En savoir plus sur le service API Contacter l'équipe commerciale

Pages associées

Démarrage rapide Téléchargement SDK Exemples de code Journal des modifications