Passer au contenu principal
Récupère une annonce (publication d’un bien) par son id MongoDB ou sa reference métier, avec le contact rattaché, la localisation et les médias.

Endpoint

URL : /external-integration/ad Méthode : GET Authentification : Requiert un token LinkedAPI avec scope externalIntegration et une clé rattachée à un groupe d’agences. Clé requise : toutes les clés (lecture seule suffit). Voir Types de clé.

Headers

Query Parameters

Exactement un des deux paramètres suivants doit être fourni :
id et reference sont mutuellement exclusifs. Zéro ou plus d’un → 400.

Exemples de requête

Réponse de succès

Code : 200

Annonce trouvée

Annonce non trouvée ou hors scope

Champs de la réponse

location

Les champs non renseignés sont absents de la réponse (pas retournés à null). Quand isLocationDisplayed vaut false, number et route ne sont pas exposés.

Réponses d’erreur

  • Aucun paramètre fourni : 400 Bad Request
  • Les deux paramètres fournis : 400 Bad Request
  • LinkedAPI agencyGroup manquant : 400 Bad Request
  • Header Authorization absent, ou IP non whitelistée sur une clé sécurisée : 403 Not authorized to access this resource
  • Token invalide : 401 Invalid bearer token

Notes

  1. Scope : une annonce hors de votre périmètre autorisé ne sera jamais retournée (ad: null).
  2. Médias : les pictures sont des URLs CloudFront publiques (pas de lien signé temporaire).
  3. Localisation : number et route ne sont exposés que si isLocationDisplayed vaut true.
  4. Champs location/honoraires : les champs de location (rental*) ne sont renseignés que pour les annonces de location ; les champs de vente (sale*) pour les annonces de vente.
  5. Endpoint en lecture seule.

Rate limits

Cette route est limitée à 500 req / minute par groupe d’agences (bucket dédié).
  • Headers : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (secondes avant reset).
  • Dépassement → 429 Too Many Requests avec header Retry-After :