Documentation de l'API BG Wiper

Vue d'ensemble

L'API BG Wiper est une application basée sur Flask qui permet aux utilisateurs de télécharger des images et de supprimer leurs arrière-plans. L'API prend en charge les images aux formats JPEG et PNG, avec une taille maximale de fichier de 5 Mo. Les utilisateurs peuvent télécharger les images d'origine et les images dont l'arrière-plan a été supprimé via des URL générées.

URL de base

L'URL de base de l'API en production est :

https://bgwiper.dommacademy.com

Points de terminaison

1. Suppression de l'arrière-plan

• Point de terminaison : /remove-bg

• Méthode : POST

• Description : Téléchargez une image pour supprimer son arrière-plan.

Requête

• Content-Type : multipart/form-data

• Données du formulaire :
  • image : Le fichier image à traiter (JPEG ou PNG).

Exemple de requête avec curl :

curl -X POST https://bgwiper.dommacademy.com/remove-bg \
-F "image=@chemin/vers/votre/image.jpg"

Réponse

• Succès (200) : Renvoie un objet JSON avec des URL pour les images d'origine et celles dont l'arrière-plan a été supprimé.

{
  "original_image_url": "https://bgwiper.dommacademy.com/download/unique_id_original.png",
  "no_bg_image_url": "https://bgwiper.dommacademy.com/download/unique_id_no_bg.png"
}

• Erreur (400) : Si un problème se produit avec le fichier image (manquant, format non pris en charge ou dépasse les limites de taille), un message d'erreur sera renvoyé.

{
  "error": "Aucune image trouvée"  // Exemple d'image manquante
}

Remarques d'utilisation

• Formats d'image acceptés : L'API accepte uniquement les images aux formats JPEG et PNG.

• Taille maximale de fichier : La taille maximale autorisée pour les téléchargements est de 5 Mo. Les fichiers dépassant cette taille renverront une erreur.

• Format de réponse : Toutes les réponses sont au format JSON.

Gestion des erreurs

L'API fournit des messages d'erreur informatifs, notamment :

• Image manquante dans la requête.

• Format de fichier non pris en charge.

• Taille de fichier dépassant la limite maximale.

Conclusion

L'API BG Wiper offre une interface simple pour la suppression de l'arrière-plan des images, permettant aux utilisateurs de télécharger et de récupérer facilement leurs images. Veuillez suivre les directives d'utilisation pour une expérience fluide.