Panduan integrasi Housing Market API
Jadual rujukan, perihalan titik akhir, kod ralat dan contoh dijana daripada spesifikasi API dan kekal dalam bahasa Inggeris dalam setiap bahasa. Nama, parameter dan kod adalah sama di mana-mana.
Pengesahan
Hantar kunci anda dalam pengepala x-api-key pada setiap permintaan.
Simpan kunci di pelayan anda. Jangan sekali-kali meletakkannya dalam aplikasi mudah alih, halaman web atau repositori awam: sesiapa yang memegangnya boleh menggunakan langganan anda.
Satu kunci milik seorang pelanggan. Jangan kongsikannya dengan syarikat lain; terma melarangnya, dan kami dapat melihat dari mana kunci digunakan.
Satu kunci membawa semua akses anda: negara dan pelan anda. Apabila anda menambah negara atau menaik taraf, kunci itu dikemas kini; anda tidak mendapat kunci baharu.
Kunci yang tiada, tidak dikenali atau dibatalkan ditolak dengan unauthenticated. Kunci sah yang digunakan dari alamat yang tidak berdaftar 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"