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.
IP-Freigabeliste
Ein Schlüssel funktioniert nur von der für ihn registrierten IP-Adresse aus. Sie registrieren beim Abonnieren eine Adresse.
Um herauszufinden, welche Adresse wir sehen, rufen Sie GET /v1/ping von Ihrem Server aus auf. Die Antwort gibt sie im Feld address zurück. Registrieren Sie diese Adresse, nicht die Adresse Ihres Büros oder Ihres Laptops.
Eine Anfrage von einer anderen Adresse wird mit ip_not_allowed abgelehnt, auch wenn der Schlüssel korrekt ist. Es werden sowohl IPv4- als auch IPv6-Adressen akzeptiert.
Sie können die registrierte Adresse in der Konsole ändern. Änderungen werden protokolliert und sind begrenzt. Registrieren Sie daher die ausgehende Adresse eines stabilen Servers, und verwenden Sie eine statische ausgehende Adresse, wenn Ihre Server bei einem Cloud-Anbieter laufen.
Wenn Ihre Server hinter einem Proxy oder einem NAT-Gateway liegen, registrieren Sie die Adresse des Proxys bzw. Gateways, denn das ist die Adresse, die wir sehen.
GET /v1/ping
Check your key and the address we see
Confirms that the key is accepted from the address the request came from, and echoes that address. Use it to check the IP you registered before you build anything else.
Parameters
No parameters.
Responses
| Status | Description | Error codes |
|---|---|---|
200 | The key is valid and the address is registered. | |
401 | The key is missing, unknown or revoked. | unauthenticated |
403 | The key is valid but this request is refused. | ip_not_allowed key_paused |
429 | A rate limit or a quota has been reached. | rate_limited quota_exceeded |
503 | The service cannot answer right now. | service_unavailable |