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.
Autentikasi
Kirimkan kunci Anda di header x-api-key pada setiap permintaan.
Simpan kunci di server Anda. Jangan pernah menaruhnya di aplikasi seluler, halaman web, atau repositori publik: siapa pun yang memegangnya dapat menggunakan langganan Anda.
Satu kunci dimiliki oleh satu pelanggan. Jangan bagikan kunci kepada perusahaan lain; ketentuan melarangnya, dan kami dapat melihat dari mana kunci digunakan.
Satu kunci membawa seluruh akses Anda: negara dan paket Anda. Saat Anda menambah negara atau meningkatkan paket, cakupan kunci berubah; Anda tidak mendapatkan kunci baru.
Kunci yang tidak ada, tidak dikenal, atau dicabut ditolak dengan unauthenticated. Kunci valid yang digunakan dari alamat yang tidak terdaftar ditolak dengan ip_not_allowed. Kunci yang dijeda ditolak dengan key_paused.
Contoh permintaan
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"