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.

Einen Schlüssel erhalten

Sie erhalten einen Schlüssel, indem Sie in der Konsole ein Abonnement abschließen. Es gibt keine Freigabewarteschlange, und Sie müssen keine E-Mail senden.

  1. Melden Sie sich in der Konsole an oder erstellen Sie ein Konto. Es ist dasselbe Konto, das Sie für andere Housing Market-Produkte verwenden.
  2. Wählen Sie die Länder, eine Region oder weltweit, den Tarif sowie monatliche oder jährliche Abrechnung.
  3. Geben Sie die IP-Adresse ein, von der aus Ihre Server die API aufrufen werden.
  4. Akzeptieren Sie die Nutzungsbedingungen der API. Wir speichern einen Nachweis darüber, was Sie wann akzeptiert haben.
  5. Bezahlen Sie. Ihr Schlüssel erscheint erst, nachdem die Zahlung erfolgreich war, und er wird nur einmal angezeigt.

Kopieren Sie den Schlüssel direkt in Ihren Secret-Speicher. Wir speichern nur einen Einweg-Hash davon und können ihn Ihnen daher nicht erneut anzeigen. Ein Schlüssel sieht so aus: hma_<prefix>_<secret>.

Sie können in der Konsole jederzeit einen Ersatzschlüssel erstellen. Der alte Schlüssel funktioniert danach noch 24 Stunden lang, sodass Sie ohne Ausfallzeit umstellen können.

Schlüsselstatus

  • Aktiv: Der Schlüssel funktioniert.
  • Pausiert: Der Schlüssel wird mit key_paused abgelehnt. Er wird automatisch wieder aktiv, sobald der Grund behoben ist.
  • Widerrufen: Der Schlüssel wird dauerhaft mit unauthenticated abgelehnt.

Schlägt eine Verlängerungszahlung fehl, funktioniert Ihr Schlüssel während einer Kulanzfrist von 5 Tagen weiter, in der wir Sie bei jedem Schritt per E-Mail benachrichtigen, und wird danach pausiert. Ein pausierter Schlüssel wird automatisch wieder aktiv, sobald die Zahlung beglichen ist. Eine angefochtene Zahlung pausiert den Schlüssel sofort, bis sie geprüft wurde.

Das Hinzufügen eines Landes oder ein Upgrade wird sofort anteilig berechnet und gilt kurz nach Bestätigung der Zahlung für denselben Schlüssel. Das Entfernen eines Landes oder ein Downgrade wird bei der nächsten Verlängerung wirksam.