Guide technique

API immobilière REST : architecture, bonnes pratiques, exemples

Le marché immobilier français est en transition : les exports XML legacy laissent progressivement la place aux API REST modernes. Voici un panorama complet : pourquoi REST, quels endpoints exposer, comment versionner, comment sécuriser, et comment Ts-Immo expose une API REST unifiée au-dessus des CRM existants.

Pourquoi REST plutôt que XML ?

Les exports XML restent dominants en France pour des raisons historiques. Mais REST offre des avantages décisifs pour les sites modernes.

  • JSON natif — directement consommable par JavaScript / TypeScript
  • Pagination simple via query params
  • Filtres natifs (?type=apartment&minPrice=200000)
  • Verbes HTTP standardisés (GET, POST, PUT, DELETE)
  • Sécurité moderne (HTTPS + Bearer tokens)
  • Versioning facile (/v1/, /v2/)

L'architecture Ts-Immo en bref

Ts-Immo expose une API REST unifiée au-dessus des CRM existants. Vous interrogez toujours api.ts-immo.org — quelle que soit la source en amont (Apimo, Hektor, Netty, Sweepbright, etc.).

Récupérer la liste des biens
# Public — sans authentification
curl https://api.ts-immo.org/v1/gateway/public/properties/agence-cote-d-azur

# Client — avec API token
curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.ts-immo.org/v1/gateway/properties

Exemple de réponse JSON

Format unifié Ts-Immo
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "uri": {
      "fr": "agence-cote-d-azur/villa-4-pieces-vue-mer",
      "en": "agence-cote-d-azur/4-room-villa-sea-view"
    },
    "type": "house",
    "offer_type": "sale",
    "status": "available",
    "title": { "fr": "Villa 4 pièces vue mer", "en": "4-room villa sea view" },
    "bedrooms": 3,
    "financial": {
      "transaction": {
        "price": { "amount": 850000.00, "currency": "EUR" }
      }
    },
    "location": {
      "city": "Nice",
      "postal_code": "06000",
      "country": "France"
    },
    "images": [
      { "url": "https://cdn.ts-immo.org/photo1.jpg", "ordinal": 0 }
    ]
  }
]

Endpoints principaux

MéthodeEndpointDescription
GET/v1/gateway/propertiesListe des biens (auth)
GET/v1/gateway/properties/:idDétail d'un bien
GET/v1/gateway/public/properties/:slugListe publique par agence
GET/v1/gateway/public/properties/:slug/:uriDétail public d'un bien
POST/v1/gateway/leadsCréation d'un lead
GET/v1/gateway/public/dvfDonnées DVF (transactions)

Versioning et compatibilité

L'API Ts-Immo applique un versioning strict via le préfixe /v1/. Les évolutions non rétro-compatibles passent en /v2/ — la v1 reste maintenue 12 mois minimum après publication d'une nouvelle version majeure.

Sécurité

  • Bearer token API par client
  • TLS 1.3 obligatoire
  • Rate limiting (60 req/min standard, 600 req/min Pro)
  • CORS configurable par origine
  • Audit log des accès

Questions fréquentes

Faut-il une clé API pour les biens publics ?+

Non. /v1/gateway/public/* est librement accessible. C'est utile pour les sites publics qui consomment directement l'API.

Comment versionner mon intégration ?+

Préfixez toujours avec /v1/. Quand v2 sortira, vous testerez la migration sur un environnement de staging avant de basculer.

Le SDK TypeScript est-il prêt ?+

Un SDK officiel @ts-immo/sdk est en cours de publication. En attendant, l'API REST est entièrement documentée et facile à consommer en direct.

Mots-clés associés

apirestjsonarchitecture

Prêt à connecter votre CRM ?

Démarrez gratuitement ou contactez-nous pour une démonstration personnalisée de Ts-Immo.

API immobilière REST — architecture et bonnes pratiques 2026 — Ts-Immo