Hướng dẫn tích hợp Housing Market API
Các bảng tham chiếu, mô tả endpoint, mã lỗi và ví dụ được tạo từ đặc tả API và được giữ nguyên bằng tiếng Anh ở mọi ngôn ngữ. Tên, tham số và mã đều giống nhau ở mọi nơi.
Danh sách IP được phép
Khóa chỉ hoạt động từ địa chỉ IP đã đăng ký cho khóa đó. Bạn đăng ký một địa chỉ khi đăng ký gói.
Để biết chúng tôi thấy địa chỉ nào, hãy gọi GET /v1/ping từ máy chủ của bạn. Phản hồi sẽ trả lại địa chỉ đó trong trường address. Hãy đăng ký địa chỉ này, không phải địa chỉ của văn phòng hay máy tính xách tay của bạn.
Yêu cầu từ bất kỳ địa chỉ nào khác đều bị từ chối với ip_not_allowed, ngay cả khi khóa đúng. Cả địa chỉ IPv4 và IPv6 đều được chấp nhận.
Bạn có thể thay đổi địa chỉ đã đăng ký trong bảng điều khiển. Các thay đổi được ghi nhật ký và bị giới hạn, vì vậy hãy đăng ký địa chỉ đi ra (outbound) của một máy chủ ổn định, và dùng địa chỉ đi ra tĩnh nếu bạn chạy trên một nhà cung cấp đám mây.
Nếu máy chủ của bạn nằm sau một proxy hoặc cổng NAT, hãy đăng ký địa chỉ của proxy hoặc cổng đó, vì đó là địa chỉ chúng tôi thấy.
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 |