🏠 Guide d'Utilisation API Logements - Démarrage Rapide¶

📁 Fichiers Fournis¶

Vous avez reçu ces fichiers pour utiliser l'API Boaz Housing :

📋 GUIDE_API_LOGEMENTS.md          # Documentation complète (LIRE EN PREMIER)
🧪 test_rapide_api.py              # Test rapide pour vérifier que tout marche
🏠 script_ajout_logement_simple.py # Ajouter UN logement (débutants)
📦 script_ajout_logements_json.py  # Ajouter PLUSIEURS logements depuis JSON
📄 exemple_logements.json          # Exemple de fichier avec 15 logements

🚀 Démarrage en 3 Étapes¶

Étape 1: Tester la Connexion (2 minutes)¶

1	`python3 test_rapide_api.py`

✅ Si tout est vert : Votre connexion fonctionne, passez à l'étape 2 ❌ Si ça échoue : Vérifiez votre connexion internet et contactez le support

Étape 2: Ajouter Votre Premier Logement (5 minutes)¶

Ouvrez script_ajout_logement_simple.py avec un éditeur de texte

Modifiez les variables en haut du fichier :

TITRE = "Mon Premier Logement"
ADRESSE = "123 Ma Rue, Ma Ville"
VILLE = "Paris"
CODE_POSTAL = "75001"
LOYER = 850.00
CHARGES = 120.00

Exécutez :

1	`python3 script_ajout_logement_simple.py`

✅ Résultat attendu : "🎉 SUCCÈS ! Logement créé avec succès !"

Étape 3: Importer Plusieurs Logements (10 minutes)¶

Option A: Utiliser l'Exemple Fourni¶

1	`python3 script_ajout_logements_json.py`

(Utilise automatiquement le fichier exemple_logements.json fourni)

Option B: Créer Votre Propre Fichier¶

Copiez exemple_logements.json vers mes_logements.json
Modifiez mes_logements.json avec vos données

Changez dans script_ajout_logements_json.py :

JSON_FILE = "mes_logements.json"  # Votre fichier

Exécutez :

1	`python3 script_ajout_logements_json.py`

📋 Format JSON Requis¶

Votre fichier JSON doit être une liste de logements :

[
  {
    "titre": "Studio moderne",
    "description": "Studio 20m² meublé",
    "adresse": "15 Rue Example, Paris",
    "ville": "Paris",
    "code_postal": "75001",
    "pays": "France",
    "loyer": 850.00,
    "montant_charges": 120.00,
    "statut": "disponible"
  },
  {
    "titre": "Autre logement...",
    "description": "...",
    "adresse": "...",
    "ville": "...",
    "code_postal": "...",
    "pays": "France",
    "loyer": 1200.00,
    "montant_charges": 150.00,
    "statut": "disponible"
  }
]

Champs Obligatoires ✅¶

titre (texte, 3-200 caractères)
adresse (texte, 5-500 caractères)
ville (texte, 2-100 caractères)
code_postal (texte, format valide)
loyer (nombre > 0)

Champs Optionnels ⚪¶

description (texte, max 2000 caractères)
pays (défaut: "France")
montant_charges (nombre ≥ 0, défaut: 0)
statut (défaut: "disponible")

⚠️ Erreurs Fréquentes et Solutions¶

"Module 'requests' not found"¶

pip install requests
# ou
pip3 install requests

"Fichier JSON introuvable"¶

Vérifiez que le fichier est dans le même dossier que le script
Vérifiez l'orthographe du nom de fichier

"Erreur format JSON"¶

Utilisez un validateur JSON en ligne : https://jsonlint.com
Vérifiez les virgules, guillemets et crochets

"Logement déjà existant"¶

Normal ! Le script détecte les doublons automatiquement
Changez l'adresse ou supprimez l'ancien logement

"Le loyer doit être supérieur à 0"¶

Vérifiez que le loyer est un nombre (pas de texte)
Utilisez un point pour les décimales : 850.50 pas 850,50

📞 Support et Aide¶

Documentation Complète¶

📖 GUIDE_API_LOGEMENTS.md - Tout est expliqué en détail !

Interface Web¶

🌐 https://api-housing.boaz-study.tech/docs - Documentation interactive

Contact¶

📧 no-reply@boaz-study.com

💡 Conseils Pro¶

Pour les Débutants¶

Commencez TOUJOURS par test_rapide_api.py
Ajoutez UN logement d'abord avec script_ajout_logement_simple.py
Puis utilisez script_ajout_logements_json.py pour l'import en masse

Pour l'Import en Masse¶

Testez avec 2-3 logements d'abord
Le script vérifie automatiquement les doublons
Une pause de 0.5s entre chaque requête évite la surcharge
Gardez une sauvegarde de vos fichiers JSON

Validation¶

Validez toujours votre JSON avec https://jsonlint.com
Vérifiez les codes postaux selon le pays
Les prix doivent être en euros avec des points (pas virgules)

✅ Checklist Avant Import¶

Test de connexion OK (test_rapide_api.py)
Premier logement créé avec succès
Fichier JSON validé sur jsonlint.com
Sauvegarde du fichier JSON effectuée
Script configuré avec le bon nom de fichier

🎯 Vous êtes maintenant prêt à utiliser l'API Boaz Housing ! 🚀

En cas de problème, consultez le guide complet GUIDE_API_LOGEMENTS.md ou contactez le support.