Skip to main content

Guide d'Intégration

Cette documentation détaille l'API NC.CAM.Services.DocumentCompressor, qui permet de compresser un document PDF au maximum en fonction d'une taille cible (5 Mo par défaut).

  • Nom : NC.CAM.Services.DocumentCompressor
  • Version de l'API : 1.0

Compresser un fichier PDF

Cet endpoint permet de soumettre un fichier pour une compressions avec une taille cible.

  • URL : /Compress
  • Méthode : POST

Appel

Content-Type

  • multipart/form-data

Paramètres du formulaire

NomTypeDescription
filestring (binary)Fichier PDF à compresser, envoyé en binaire
TargetSizeInMBintTaille cible du PDF compressé en mégaoctets (par défaut : "5")
RemoveStructureTreebooleanSupprimer l'arbre de structure pour réduire la taille (false/true)
ShrinkImagesbooleanRéduire la taille des images dans le PDF (false/true)
HighQualityImageSubsamplingbooleanUtiliser un sous-échantillonnage haute qualité pour les images (false/true)
CompressStructTreebooleanCompressé la structure du PDF pour un gain supplémentaire (false/true)

Exemples de Requête

Voici un exemple de requête pour envoyer un fichier à compresser :

curl -X POST "https://api.example.com/Compress" \
-H "Content-Type: multipart/form-data" \
curl --location --request POST 'https://localhost:5001/compress' \
-F "file=@/chemin/vers/le/fichier.pdf"
--form 'TargetSizeInMB="5"'
--form 'RemoveStructureTree="false"' \
--form 'ShrinkImages="false"' \
--form 'HighQualityImageSubsampling="false"' \
--form 'CompressStructTree="false"'

Réponses

  • 200 OK : la requête a été traitée avec succès et le fichier pdf compressé est retourné.
  • 400 Bad Request : Si le fichier n'est pas fourni ou si le format est incorrect.
  • 500 Internal Server Error : Erreur serveur lors de la compression du fichier.