Guide d’intégration de la Housing Market API
Les tableaux de référence, les descriptions des points de terminaison, les codes d’erreur et les exemples sont générés à partir de la spécification de l’API et restent en anglais dans toutes les langues. Les noms, paramètres et codes sont identiques partout.
Authentification
Envoyez votre clé dans l’en-tête x-api-key de chaque requête.
Conservez la clé sur votre serveur. Ne la placez jamais dans une application mobile, une page web ou un dépôt public : toute personne qui la détient peut utiliser votre abonnement.
Une clé appartient à un seul client. Ne la partagez pas avec une autre entreprise : les conditions l’interdisent, et nous pouvons voir d’où une clé est utilisée.
Une seule clé porte l’ensemble de vos accès : vos pays et votre formule. Lorsque vous ajoutez un pays ou passez à une formule supérieure, la clé est mise à jour ; vous n’en recevez pas de nouvelle.
Une clé absente, inconnue ou révoquée est refusée avec unauthenticated. Une clé valide utilisée depuis une adresse non enregistrée est refusée avec ip_not_allowed. Une clé suspendue est refusée avec key_paused.
Exemple de requête
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"