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.

Lấy khóa

Bạn nhận khóa bằng cách đăng ký gói trong bảng điều khiển. Không có hàng chờ phê duyệt và không cần gửi email.

  1. Đăng nhập vào bảng điều khiển hoặc tạo tài khoản. Đây là cùng tài khoản bạn dùng cho các sản phẩm Housing Market khác.
  2. Chọn quốc gia, một khu vực hoặc toàn cầu, chọn gói, và hình thức thanh toán hằng tháng hoặc hằng năm.
  3. Nhập địa chỉ IP mà máy chủ của bạn sẽ dùng để gọi API.
  4. Chấp nhận điều khoản sử dụng API. Chúng tôi lưu hồ sơ về những gì bạn đã chấp nhận và thời điểm chấp nhận.
  5. Thanh toán. Khóa của bạn chỉ xuất hiện sau khi thanh toán thành công và chỉ được hiển thị một lần.

Hãy sao chép khóa thẳng vào kho bí mật của bạn. Chúng tôi chỉ lưu một giá trị băm một chiều của khóa, nên không thể hiển thị lại cho bạn. Khóa có dạng hma_<prefix>_<secret>.

Bạn có thể tạo khóa thay thế trong bảng điều khiển bất cứ lúc nào. Sau khi bạn tạo, khóa cũ vẫn tiếp tục hoạt động trong 24 giờ để bạn có thể chuyển đổi mà không bị gián đoạn.

Trạng thái khóa

  • Đang hoạt động: khóa hoạt động bình thường.
  • Tạm dừng: khóa bị từ chối với key_paused. Khóa tự động hoạt động lại khi nguyên nhân được giải quyết.
  • Đã thu hồi: khóa bị từ chối vĩnh viễn với unauthenticated.

Nếu thanh toán gia hạn không thành công, khóa của bạn vẫn hoạt động trong thời gian ân hạn 5 ngày, trong thời gian đó chúng tôi gửi email cho bạn ở mỗi bước, sau đó khóa bị tạm dừng. Khóa bị tạm dừng sẽ tự động hoạt động lại ngay khi khoản thanh toán được hoàn tất. Một khiếu nại thanh toán sẽ tạm dừng khóa ngay lập tức cho đến khi được xem xét xong.

Việc thêm quốc gia hoặc nâng cấp được tính phí ngay theo tỷ lệ thời gian và được áp dụng cho cùng một khóa ngay sau khi thanh toán được xác nhận. Việc bớt quốc gia hoặc hạ cấp có hiệu lực vào lần gia hạn tiếp theo.