Image compressée API
Fonctionnement de ce point de terminaison : Le PDF4me Image compressée REST API réduit la taille du fichier JPG, PNG, et les images WebP grâce à des algorithmes de compression intelligents. Envoyez votre image au format . Base64chaîne encodée, définissez le format de sortie et le niveau de compression, et recevez en retour une image compressée, le tout en une seule opération synchrone POST Utilisez cette fonction pour optimiser les images de produits pour les pages e-commerce, réduire la taille des ressources téléchargées dans les pipelines CMS, générer des vignettes ou réduire les coûts de bande passante dans toute application gérant des fichiers image.
Authentification de votre API Demande
Chaque PDF4me REST API L'appel doit inclure votre API clé dans le Authorization En-tête. Récupérez votre clé depuis le tableau de bord développeur et gardez-la secrète, ne l'exposez jamais dans le code côté client.
Informations importantes à ne pas manquer
File Name, File Content, Image Type, and Compression Level must all be present in the request payload. A missing or empty field causes a 400 Bad Request error. Validate all four values in your code before sending the API call.
The API uses Image Type to select the correct decompression codec before re-encoding. Sending PNG data with Image Type set to JPG causes a format mismatch error. Always read the actual MIME type or file extension from your source and set Image Type to match.
Max reduces file size by 80-90%: ideal for thumbnails and social media previews where pixel-perfect detail is less important. Medium (60-70% reduction) suits most product and blog images. Low (30-40% reduction) is recommended when you need to preserve fine detail for print, zoom features, or professional photography archives.
REST API Point de terminaison
| Méthode | Point de terminaison |
|---|---|
| POST | /api/v2/CompressImage |
URL de base : https://api.pdf4me.com
Paramètres
⚠️ Les quatre paramètres sont requis. Le API renvoie une erreur si un champ est manquant ou vide.
| Paramètre | Requis | Taper | Ce que cela fait | Exemple |
|---|---|---|---|---|
| docName | Required | String | Filename of the source image including the file extension. Used to identify the format and name the output file. Use descriptive, extension-correct names. | product-hero.jpg |
| docContent | Required | Base64 | The complete image file encoded as a Base64 string. Supported formats: JPG/JPEG, PNG, WebP. Maximum file size: 50 MB. Do not include a data URL prefix: pass the raw Base64 string only. | JVBERi0xLjQK... |
| imageType | Required | Enum | Output image format. Must match the actual format of docContent. Accepted values: JPG · PNG · WebP | JPG |
| compressionLevel | Required | Enum | Compression intensity. Max: 80-90% size reduction, good quality (thumbnails, social media). Medium, 60-70% reduction, very good quality (product images, blogs). Low, 30-40% reduction, excellent quality (print, zoom, archives). | Medium |
Champs de sortie
| Champ | Taper | Description |
|---|---|---|
| Contenu du fichier | Base64 | Le fichier image compressé encodé comme Base64Décodez en binaire pour l'enregistrer dans un fichier. |
| Nom de fichier | String | Nom du fichier image compressée. |
Exemple de requête
En-têtes
Content-Type: application/json
Authorization: YOUR_API_KEY
Charge utile JSON
{
"docName": "product-hero.jpg",
"docContent": "JVBERi0xLjQK...",
"imageType": "JPG",
"compressionLevel": "Medium"
}
Réponse
{
"File Content": "BASE64_COMPRESSED_IMAGE_DATA",
"File Name": "product-hero.jpg"
}
Exemples de code
Cas d'utilisation courants
Compress JPG product photos to Medium level before serving on listing pages. Reduces page load time by 60-70% without visible quality loss on standard displays: directly improving Core Web Vitals and conversion rates.
Intercept image uploads in your CMS (WordPress, Contentful, Strapi) and run them through Compress Image at Max level before storing. Thumbnails and hero banners benefit most: users see no quality difference at normal viewing sizes.
High-resolution press images (300+ DPI, often 20-50 MB) can be compressed at Low level to maintain near-print quality while reducing file size by 30-40%. Ideal for photography portfolios, architectural galleries, and product zoom features.
Foire aux questions
▶ What is the maximum file size the Compress Image API accepts?
The API accepts images up to 50 MB. For best performance, keep images under 10 MB. Larger files increase processing time significantly and may exceed request timeouts on slow connections.
▶ Does Image Type need to match the actual binary format of File Content?
Yes: always. The API uses imageType to select the correct decompression codec before re-encoding at the chosen quality level. Sending PNG data with imageType set to JPG causes a format mismatch error. Read the actual MIME type or file extension from your source and set imageType to match exactly.
▶ Which Compression Level should I use for e-commerce product images?
Medium is the recommended level for most product images. It reduces file size by 60-70% while maintaining very good visual clarity for standard monitor and mobile display sizes. Use Low only when your product images include fine textures or details that customers zoom into.
▶ Can I convert and compress an image (e.g. PNG to WebP) in the same API call?
No: Compress Image only compresses within the same format. To convert between formats, call the Convert Image Format endpoint first, then pass the result to Compress Image in a second call. Chain these two calls in your application for a compress-and-convert pipeline.
▶ Is the output File Content returned as Base64 or binary?
The output File Content is Base64-encoded. Decode it to binary before writing to a file. In Python: base64.b64decode(response["File Content"]). In Node.js: Buffer.from(response["File Content"], "base64").