API

Documentation de l'API REST de SigCleaner.

Chaque requête \/api\/clean réussie déduit 1 traitement du solde du compte.

Méthode : suppression de l'arrière-plan

POST https://sigclean.io/api/clean
Autorisation
Authorization: Bearer YOUR_API_KEY
Paramètres de la requête
ParamètreTypeObligatoireDescription
file multipart file L'un des deux Image PNG, JPG ou PDF.
S'il s'agit d'un PDF multipage — seule la première page est traitée.
url string L'un des deux Lien direct vers l'image
type string Non json (par défaut) — renvoie un JSON avec un lien vers le fichier
webp — renvoie un fichier binaire WebP avec un fond transparent
png — renvoie un fichier binaire PNG avec un fond transparent
extract string Non Extraction d'un élément spécifique. Vide par défaut — suppression de fond standard.
signature — conserve uniquement la signature manuscrite, en supprimant tout le reste.
stamp — conserve uniquement l'empreinte du cachet, en supprimant tout le reste.
aggressive boolean Non Suppression agressive du texte.
Si défini sur 1 (true), supprime de manière agressive toutes les lettres imprimées, les chiffres et les lignes noires droites du document, en ne conservant que l'élément spécifié.
mode string Non Mode de traitement. Par défaut — standard.
standard — mode standard. Idéal pour les images de bonne qualité. Le résultat est le plus fidèle possible à l'original.
advanced — mode intelligent. Traitement plus approfondi ; idéal pour les images de mauvaise qualité ou contenant de nombreux éléments parasites.
name string Non Nom du fichier affiché dans la liste « Mes fichiers ». Sauvegardé en cas de traitement réussi.
Réponse : type=json
{ "status": "ok", "uuid": "550e8400-e29b-41d4-a716-446655440000", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "remaining": 9, "limit": 10 }
Réponse : type=webp

Renvoie un fichier binaire WebP avec un fond transparent. Content-Type: image/webp.

Réponse : type=png

Renvoie un fichier binaire PNG avec un fond transparent. Content-Type: image/png.

Exemples cURL
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=json"
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ --output result.png
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=webp" \ --output result.webp

Extraction de signature avec suppression agressive du texte :

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@document.jpg" \ -F "type=png" \ -F "extract=signature" \ -F "aggressive=1" \ --output signature.png

Mode de traitement intelligent :

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ -F "mode=advanced" \ --output result.png
Télécharger le résultat
GET https://sigclean.io/api/file/{uuid}

Méthode : liste des fichiers

GET https://sigclean.io/api/files

Renvoie la liste de tous les fichiers traités avec succès appartenant à l'utilisateur actuel. Les fichiers sont accessibles via un lien /api/file/{uuid}.

Autorisation
Authorization: Bearer YOUR_API_KEY
Réponse
{ "status": "ok", "files": [ { "uuid": "550e8400-e29b-41d4-a716-446655440000", "name": "stamp.jpg", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "created_at": "2026-07-01T10:00:00Z", "expires_at": "2027-07-01T10:00:00Z" } ] }
ChampTypeDescription
uuid string Identifiant unique du fichier
name string | null Nom du fichier affiché (à partir du paramètre name lors de \/api\/clean ou après renommage)
url string Lien direct pour télécharger le fichier (WebP)
created_at string (ISO 8601) Date et heure de création du fichier (UTC)
expires_at string | null Date d'expiration de la conservation (UTC).
Exemple cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Méthode : suppression de fichier

POST https://sigclean.io/api/files/delete

Supprime définitivement le fichier du serveur. Le fichier doit appartenir à l'utilisateur actuel.

Autorisation
Authorization: Bearer YOUR_API_KEY
Corps de la requête application\/json
ParamètreTypeObligatoireDescription
uuid string Oui UUID du fichier provenant de la réponse \/api\/clean ou \/api\/files.
Réponse
{ "status": "ok" }
Codes d'erreur
CodeDescription
401Non autorisé
404Fichier introuvable ou n'appartenant pas à l'utilisateur
422uuid manquant ou invalide
Exemple cURL
curl -X POST https://sigclean.io/api/files/delete \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000"}'

Méthode : renommage de fichier

POST https://sigclean.io/api/files/rename

Modifie le nom affiché du fichier. Le fichier doit appartenir à l'utilisateur actuel.

Autorisation
Authorization: Bearer YOUR_API_KEY
Corps de la requête application\/json
ParamètreTypeObligatoireDescription
uuid string Oui UUID du fichier provenant de la réponse \/api\/clean ou \/api\/files.
name string Oui Nouveau nom affiché du fichier (jusqu'à 255 caractères).
Réponse
{ "status": "ok", "name": "stamp.jpg" }
Codes d'erreur
CodeDescription
401Non autorisé
404Fichier introuvable ou n'appartenant pas à l'utilisateur
422uuid \/ name manquant ou invalide
Exemple cURL
curl -X POST https://sigclean.io/api/files/rename \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000","name":"stamp.jpg"}'

Gestion des clés API

Vous devez vous connecter pour gérer les clés.