คู่มือการผสานรวม Housing Market API
ตารางอ้างอิง คำอธิบายเอนด์พอยต์ รหัสข้อผิดพลาด และตัวอย่าง สร้างขึ้นจากสเปกของ API และคงเป็นภาษาอังกฤษในทุกภาษา ชื่อ พารามิเตอร์ และรหัสจะเหมือนกันทุกที่
รายการที่อยู่ IP ที่อนุญาต
คีย์จะใช้งานได้จากที่อยู่ IP ที่ลงทะเบียนไว้สำหรับคีย์นั้นเท่านั้น คุณลงทะเบียนที่อยู่หนึ่งรายการเมื่อสมัครใช้งาน
หากต้องการทราบว่าเราเห็นที่อยู่ใด ให้เรียก GET /v1/ping จากเซิร์ฟเวอร์ของคุณ การตอบกลับจะส่งที่อยู่นั้นคืนมาในฟิลด์ address โปรดลงทะเบียนที่อยู่นั้น ไม่ใช่ที่อยู่ของสำนักงานหรือแล็ปท็อปของคุณ
คำขอจากที่อยู่อื่นใดจะถูกปฏิเสธด้วย ip_not_allowed แม้ว่าคีย์จะถูกต้องก็ตาม รองรับทั้งที่อยู่ IPv4 และ IPv6
คุณสามารถเปลี่ยนที่อยู่ที่ลงทะเบียนไว้ได้ในคอนโซล การเปลี่ยนแปลงจะถูกบันทึกและมีการจำกัดจำนวนครั้ง ดังนั้นโปรดลงทะเบียนที่อยู่ขาออกของเซิร์ฟเวอร์ที่เสถียร และใช้ที่อยู่ขาออกแบบคงที่หากคุณใช้งานบนผู้ให้บริการคลาวด์
หากเซิร์ฟเวอร์ของคุณอยู่หลังพร็อกซีหรือเกตเวย์ NAT โปรดลงทะเบียนที่อยู่ของพร็อกซีหรือเกตเวย์นั้น เนื่องจากเป็นที่อยู่ที่เราเห็น
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 |