Guia de integração da Housing Market API
As tabelas de referência, as descrições dos endpoints, os códigos de erro e os exemplos são gerados a partir da especificação da API e permanecem em inglês em todos os idiomas. Nomes, parâmetros e códigos são idênticos em todos os lugares.
Lista de IPs permitidos
Uma chave só funciona a partir do endereço IP registrado para ela. Você registra um endereço ao assinar.
Para descobrir qual endereço vemos, chame GET /v1/ping a partir do seu servidor. A resposta o devolve no campo address. Registre esse endereço, e não o do seu escritório ou do seu notebook.
Uma solicitação de qualquer outro endereço é recusada com ip_not_allowed, mesmo que a chave esteja correta. São aceitos endereços IPv4 e IPv6.
Você pode alterar o endereço registrado no console. As alterações são registradas e limitadas, por isso registre o endereço de saída de um servidor estável e use um endereço de saída estático se você roda em um provedor de nuvem.
Se seus servidores ficam atrás de um proxy ou de um gateway NAT, registre o endereço do proxy ou do gateway, pois é esse o endereço que vemos.
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 |