Integrationsleitfaden für die Housing Market API

Die Referenztabellen, Endpunktbeschreibungen, Fehlercodes und Beispiele werden aus der API-Spezifikation generiert und bleiben in jeder Sprache auf Englisch. Namen, Parameter und Codes sind überall identisch.

Authentifizierung

Senden Sie Ihren Schlüssel bei jeder Anfrage im Header x-api-key.

Bewahren Sie den Schlüssel auf Ihrem Server auf. Legen Sie ihn niemals in einer mobilen App, auf einer Webseite oder in einem öffentlichen Repository ab: Wer ihn besitzt, kann Ihr Abonnement nutzen.

Ein Schlüssel gehört genau einem Kunden. Geben Sie ihn nicht an ein anderes Unternehmen weiter; die Bedingungen verbieten dies, und wir können sehen, von wo aus ein Schlüssel verwendet wird.

Ein Schlüssel umfasst Ihren gesamten Zugang: Ihre Länder und Ihren Tarif. Wenn Sie ein Land hinzufügen oder ein Upgrade vornehmen, wird der bestehende Schlüssel angepasst; Sie erhalten keinen neuen.

Ein fehlender, unbekannter oder widerrufener Schlüssel wird mit unauthenticated abgelehnt. Ein gültiger Schlüssel, der von einer nicht registrierten Adresse aus verwendet wird, wird mit ip_not_allowed abgelehnt. Ein pausierter Schlüssel wird mit key_paused abgelehnt.

Beispielanfrage

curl

curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"