Panduan integrasi Housing Market API
Tabel referensi, deskripsi endpoint, kode kesalahan, dan contoh dihasilkan dari spesifikasi API dan tetap dalam bahasa Inggris di setiap bahasa. Nama, parameter, dan kode sama di semua tempat.
Daftar IP yang diizinkan
Kunci hanya berfungsi dari alamat IP yang terdaftar untuknya. Anda mendaftarkan satu alamat saat berlangganan.
Untuk mengetahui alamat mana yang kami lihat, panggil GET /v1/ping dari server Anda. Respons akan mengembalikan alamat tersebut di field address. Daftarkan alamat itu, bukan alamat kantor atau laptop Anda.
Permintaan dari alamat lain mana pun ditolak dengan ip_not_allowed, meskipun kuncinya benar. Alamat IPv4 maupun IPv6 diterima.
Anda dapat mengubah alamat terdaftar di konsol. Perubahan dicatat dan dibatasi, jadi daftarkan alamat keluar dari server yang stabil, dan gunakan alamat keluar statis jika Anda menjalankan layanan di penyedia cloud.
Jika server Anda berada di balik proxy atau gateway NAT, daftarkan alamat proxy atau gateway tersebut, karena itulah alamat yang kami lihat.
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 |