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.
Liste d’adresses IP autorisées
Une clé ne fonctionne qu’à partir de l’adresse IP enregistrée pour elle. Vous enregistrez une adresse lors de votre abonnement.
Pour savoir quelle adresse nous voyons, appelez GET /v1/ping depuis votre serveur. La réponse vous la renvoie dans le champ address. Enregistrez cette adresse, et non celle de votre bureau ou de votre ordinateur portable.
Une requête provenant de toute autre adresse est refusée avec ip_not_allowed, même si la clé est correcte. Les adresses IPv4 et IPv6 sont toutes deux acceptées.
Vous pouvez modifier l’adresse enregistrée dans la console. Les modifications sont consignées et limitées : enregistrez donc l’adresse sortante d’un serveur stable, et utilisez une adresse sortante statique si vous êtes hébergé chez un fournisseur cloud.
Si vos serveurs se trouvent derrière un proxy ou une passerelle NAT, enregistrez l’adresse du proxy ou de la passerelle, car c’est l’adresse que nous voyons.
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 |