Documentation

ImmoWP API & intégrations

Référence API v1

Base URL : https://api.immowp.com
OpenAPI : /openapi.json

GET /v1

Discovery — liste des endpoints, liens doc, sans authentification.

GET /v1/connectors

Liste des connecteurs CRM supportés (public).

GET /v1/status

Auth requise. Query : crm, client.

Retourne l’état de la passerelle : active/désactivée, fin de contrat, dernier import (last_update_*), wordpress_url si capturée.

GET /v1/properties

Auth requise. Liste paginée. Format par défaut : normalized (schéma générique). Passez format=raw pour le modèle historique ImmoWP (plugin WP).

ParamTypeDéfautDescription
crmstringCode connecteur (requis)
clientstringSlug client (requis)
pageint1Page (1-based)
per_pageint501–200
formatstringnormalizednormalized | raw

Cache serveur ~1 h. Header X-Cache: HIT|MISS.

GET /v1/properties/{id}

Auth requise. Détail d’un bien par affId ou affNum. Query : crm, client.

POST /v1/report

Auth requise (body ou headers). Utilisé par le plugin WordPress après import.

{
  "key": "your_api_key",
  "crm": "apimo",
  "client": "demo",
  "status": "success",
  "count": 42,
  "message": "Import OK",
  "site_url": "https://agence.example"
}

statussuccess | error. Si site_url est absent, l’API tente d’extraire l’URL depuis le User-Agent WordPress (WordPress/x.y; https://…).

Headers de réponse

  • X-Request-Id — corrélation support / logs
  • X-ImmoWP-API-Version: 1
  • X-Cache — HIT ou MISS sur les listings

Codes d’erreur

HTTPcodeSignification
400BAD_REQUESTParamètre manquant ou invalide
401AUTH_FAILEDClé / crm / client invalides
403FORBIDDENPasserelle désactivée
404NOT_FOUNDEndpoint ou bien introuvable
405METHOD_NOT_ALLOWEDMéthode HTTP non supportée
500INTERNAL_ERRORErreur serveur

Legacy v0

  • GET /?variable1={crm}&variable2={client} + header Key — dump complet non paginé
  • POST /report — même sémantique que /v1/report