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.
Xác thực
Gửi khóa của bạn trong header x-api-key của mọi yêu cầu.
Hãy giữ khóa trên máy chủ của bạn. Đừng bao giờ đặt khóa trong ứng dụng di động, trang web hay kho mã công khai: bất kỳ ai có khóa đều có thể sử dụng gói đăng ký của bạn.
Mỗi khóa thuộc về một khách hàng. Không chia sẻ khóa với công ty khác; điều khoản cấm việc này, và chúng tôi có thể thấy khóa được sử dụng từ đâu.
Một khóa mang toàn bộ quyền truy cập của bạn: các quốc gia và gói của bạn. Khi bạn thêm quốc gia hoặc nâng cấp, quyền của khóa thay đổi; bạn không nhận khóa mới.
Khóa bị thiếu, không xác định hoặc đã thu hồi sẽ bị từ chối với unauthenticated. Khóa hợp lệ nhưng được dùng từ địa chỉ chưa đăng ký sẽ bị từ chối với ip_not_allowed. Khóa bị tạm dừng sẽ bị từ chối với key_paused.
Yêu cầu mẫu
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"