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.
Senarai benar IP
Kunci hanya berfungsi dari alamat IP yang didaftarkan untuknya. Anda mendaftarkan satu alamat semasa melanggan.
Untuk mengetahui alamat yang kami lihat, panggil GET /v1/ping dari pelayan anda. Respons akan memulangkan alamat itu dalam medan address. Daftarkan alamat tersebut, bukan alamat pejabat atau komputer riba anda.
Permintaan dari mana-mana alamat lain ditolak dengan ip_not_allowed, walaupun kuncinya betul. Alamat IPv4 dan IPv6 kedua-duanya diterima.
Anda boleh menukar alamat yang didaftarkan dalam konsol. Perubahan direkodkan dan dihadkan, jadi daftarkan alamat keluar bagi pelayan yang stabil, dan gunakan alamat keluar statik jika anda beroperasi pada penyedia awan.
Jika pelayan anda berada di belakang proksi atau get laluan NAT, daftarkan alamat proksi atau get laluan tersebut, kerana 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 |