Tài liệu API mở

Kết nối website, phần mềm quản lý hoặc sàn giao dịch của bạn với BĐS AI Sales Manager: đồng bộ tin đăng đã duyệt và gửi khách hàng tiềm năng về đúng chủ tin.

Xác thực bằng khoá
Gửi khoá qua header x-api-key trong mọi lượt gọi.
Hạn mức rõ ràng
Mỗi khoá có hạn mức lượt gọi mỗi phút do bạn tự đặt.
Nhật ký minh bạch
Mọi lượt gọi được ghi lại để bạn tự đối chiếu.

1. Lấy khoá API

Đăng nhập tài khoản, mở mục Tích hợp & khoá API, đặt tên khoá và chọn phạm vi truy cập. Khoá thật chỉ hiển thị một lần duy nhất — hãy lưu ngay vào nơi an toàn.

Mở trang Tích hợp & khoá API

2. Các điểm cuối

GET/api/public/v1/listingscần quyền listings:read

Danh sách tin đăng đã duyệt, có lọc và phân trang.

  • limit — số tin mỗi lần lấy (mặc định 20)
  • offset — bỏ qua bao nhiêu tin (mặc định 0)
  • province — tỉnh/thành phố
  • property_type — loại hình bất động sản
  • min_price, max_price — khoảng giá (VNĐ)
  • q — từ khoá tìm kiếm
curl -H "x-api-key: bdsk_..." \
  "https://bdsaisales.com/api/public/v1/listings?limit=20&province=Hà%20Nội"
GET/api/public/v1/listings/{slug}cần quyền listings:read

Chi tiết một tin đăng theo đường dẫn thân thiện (slug).

  • slug — mã đường dẫn của tin, lấy từ danh sách tin
curl -H "x-api-key: bdsk_..." \
  "https://bdsaisales.com/api/public/v1/listings/can-ho-2pn-quan-7"
POST/api/public/v1/leadscần quyền leads:write

Gửi khách hàng quan tâm vào phần mềm.

  • full_name (bắt buộc) — họ tên khách
  • phone (bắt buộc) — số điện thoại
  • email, note — thông tin thêm
  • property_slug — tin đăng khách quan tâm
  • channel, ref_code, utm_source, utm_medium, utm_campaign — nguồn khách
curl -X POST -H "x-api-key: bdsk_..." \
  -H "content-type: application/json" \
  -d '{"full_name":"Nguyễn Văn A","phone":"0901234567","property_slug":"can-ho-2pn-quan-7"}' \
  "https://bdsaisales.com/api/public/v1/leads"

3. Mã lỗi

401Thiếu khoá API hoặc khoá đã bị thu hồi.
403Khoá không có phạm vi truy cập cần thiết.
422Dữ liệu gửi lên không hợp lệ (thiếu tên hoặc số điện thoại).
429Vượt hạn mức lượt gọi mỗi phút của khoá.
503Quản trị đang tạm tắt API mở.

Câu hỏi thường gặp

Làm sao để lấy khoá API?

Đăng nhập tài khoản, vào mục Tích hợp & khoá API, đặt tên khoá và chọn phạm vi truy cập. Khoá thật chỉ hiển thị đúng một lần khi tạo.

API có giới hạn lượt gọi không?

Có. Mỗi khoá có hạn mức lượt gọi mỗi phút do bạn tự đặt (từ 10 đến 600). Vượt hạn mức, hệ thống trả về mã 429.

Dữ liệu trả về gồm những gì?

Chỉ tin đăng đã được duyệt và công khai trên sàn. API không trả về thông tin cá nhân của khách hàng hay dữ liệu nội bộ.

Khách gửi qua API vào đâu?

Khách được ghi thẳng vào danh sách khách hàng của chủ tin, kèm nguồn và mã chiến dịch để đo hiệu quả từng kênh.