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).
| Param | Type | Défaut | Description |
|---|---|---|---|
crm | string | — | Code connecteur (requis) |
client | string | — | Slug client (requis) |
page | int | 1 | Page (1-based) |
per_page | int | 50 | 1–200 |
format | string | normalized | normalized | 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"
}status ∈ success | 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 / logsX-ImmoWP-API-Version: 1X-Cache— HIT ou MISS sur les listings
Codes d’erreur
| HTTP | code | Signification |
|---|---|---|
| 400 | BAD_REQUEST | Paramètre manquant ou invalide |
| 401 | AUTH_FAILED | Clé / crm / client invalides |
| 403 | FORBIDDEN | Passerelle désactivée |
| 404 | NOT_FOUND | Endpoint ou bien introuvable |
| 405 | METHOD_NOT_ALLOWED | Méthode HTTP non supportée |
| 500 | INTERNAL_ERROR | Erreur serveur |
Legacy v0
GET /?variable1={crm}&variable2={client}+ headerKey— dump complet non paginéPOST /report— même sémantique que/v1/report