房源接入 API

v1.2 · 2026-06

江苏保租房 · 房源接入 API

面向运营机构(自如 / 龙湖冠寓 / 华润有巢 / 招商伊敦等)、城投 / 国资业主、保租房项目方开放。按统一房屋数据字典推送房源 → 平台清洗验真 → 住建后台监管 → 上架"市级保租房专区"。

RESTful · JSON OAuth 2.0 + 机构资质 SLA 6–8 周接入 省级价格红线校验 第三方审计:清华 / 东南 / 省社科院

1 接入概览

统一服务平台采取"住建主导、贝壳承建、同业开放"原则。机构通过本 API 推送房源与运营记录,平台完成数据清洗、价格红线校验、合规验真后统一上架;住建后台只读监管,数据接受省社科院/东南大学/省房协月度审计。

三种接入模式

模式一自营接入

适用:具备完整运营能力的机构(自如 / 龙湖 / 华润等)。

仅推送房源与备案数据;运营、收款、维修由机构闭环。

调用范围:/listings/* + /filings/*

模式二总代监管

适用:国资 / 城投有招租能力但合规需平台兜底。

平台代收代付与三方备案;机构持有经营权。

调用范围:以上 + /payments/* + /escrow/*

模式三深度托管

适用:业主无运营能力 / 信托垫资项目。

平台获完整经营权(招租 + 装改 + 收款 + 维修)。

调用范围:仅 /assets/*(业主侧资产推送即可)

环境

环境Base URL说明
沙箱https://api-sandbox.bzf.jiangsu.gov.cn对接联调,住建只读
预生产https://api-staging.bzf.jiangsu.gov.cnUAT,数据每周清空
生产https://api.bzf.jiangsu.gov.cn正式接入,住建实时监管
开放性承诺:本文档同步对外公开(GitHub Pages + 住建厅官网),对所有符合资质的机构按同等条件开放接入;接入率 / 满意度 / 投诉率指标接受第三方季度审计与公示。

2 认证授权

2.1 资质前置

仅向以下主体颁发凭证:

  • 住建厅"运营主体白名单"在册机构(≥A 级)
  • 省级国资 / 城投及其授权代理
  • 金融机构(银行 / 信托)持有的保租房项目方

申请入口:运营主体白名单 → 申请接入,材料齐全后 5 个工作日完成审核。

2.2 OAuth 2.0 (client_credentials)

POST /oauth/token 获取 access_token
POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=ziroom_jiangsu_2026
&client_secret=****
&scope=listings:write filings:write
{
  "access_token": "eyJhbGciOi...",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "listings:write filings:write"
}

2.3 请求签名(敏感写操作)

除 Bearer Token 外,写接口需要附加 X-Signature(HMAC-SHA256),算法:

signature = HMAC_SHA256(
  client_secret,
  HTTP_METHOD + "\n" + PATH + "\n" + X-Timestamp + "\n" + sha256(body)
)

请求头示例:

Authorization: Bearer eyJhbGciOi...
X-Timestamp: 1717574400
X-Nonce: a3f8c2-...
X-Signature: sha256=8a1f...
X-Operator-Id: ziroom_jiangsu_2026

2.4 限流

等级QPS日总量适用
L11050,000新接入 30 天
L250500,000稳定运营,默认
L3200不限承建方 / 大型机构(>5000 套)

3 房屋数据字典

字典由住建厅主导制定,分为静态披露字段(房屋本体属性)与动态运营记录(生命周期事件)。所有接入方按本字典推送,平台清洗后统一展示。

3.1 静态字段(Listing)

字段类型必填说明
external_idstring机构内部唯一房源 ID
operator_idstring白名单中的机构标识
project_namestring项目 / 小区名(中文)
addressobject{ city, district, street, building, room }
geoobjectWGS84 { lng, lat }
layoutstring枚举:1B1H 2B1H 3B2H STUDIO
area_sqmnumber建筑面积,保留 1 位小数
orientationstringN/S/E/W/NE/SE/SW/NW
floorobject{ current, total }
rent_monthlynumber单位元/月,须 ≤ 价格红线
service_fee_pctnumber服务费率,省级标准 ≤ 8%
market_price_refnumber市场参考价(用于展示对照)
house_qualityobject好房子 4 维度评级 — 见 3.3
amenitiesstring[]AC / FRIDGE / WASHER / WIFI / SMART_LOCK / ELEVATOR
photosobject[]≥ 6 张,详见 3.4
access_modestringSELF(自营) / AGENCY(总代) / TRUSTEE(托管)
cert_nostring保租房项目认定文号(住建口径)

3.2 动态运营记录(Event)

事件类型触发时机必传字段
LISTED上架
VIEWING_BOOKED预约带看tenant_hash, scheduled_at
CONTRACT_SIGNED签约filing_no, term_months, deposit, monthly_rent
PAYMENT_SETTLED支付到账payment_channel, amount, due_at
REPAIR_REQUESTED报修category, severity, sla_hours
REPAIR_CLOSED维修完成cost, satisfaction_score
CHECKOUT退租reason, return_amount
DELISTED下架reason

3.3 好房子四维度评级

{
  "house_quality": {
    "comfort":  4,   // 舒适:独卫、采光、隔音
    "green":    3,   // 绿色:节能门窗、空气循环
    "smart":    5,   // 科技:智能门锁、智能电表、HDR 监控
    "safety":   4    // 安全:消防、应急通道、保险覆盖
  }
}

评级 1–5;总星 = round(avg)。住建厅季度抽检,连续两季度低于 3 星将被强制下架整改。

3.4 图片资源

推送时使用对象引用,平台拉取后 CDN 化:

{
  "photos": [
    { "url": "https://cdn.ziroom.com/...", "tag": "LIVING_ROOM", "order": 1 },
    { "url": "https://cdn.ziroom.com/...", "tag": "BEDROOM_MASTER", "order": 2 }
  ]
}

分类标签:LIVING_ROOM / BEDROOM_MASTER / BEDROOM_SECOND / KITCHEN / BATHROOM / BALCONY / EXTERIOR / FLOORPLAN

4 核心接口

4.1 房源批量推送(Upsert)

POST /v1/listings:batchUpsert 单次最多 200 条
POST /v1/listings:batchUpsert
Authorization: Bearer ...

{
  "listings": [
    {
      "external_id": "ZR-NJ-2024-00188",
      "operator_id": "ziroom_jiangsu_2026",
      "project_name": "江宁·梧桐公馆人才公寓",
      "address": {
        "city": "南京市",
        "district": "江宁区",
        "street": "双龙大道 1688 号",
        "building": "3 栋",
        "room": "1506"
      },
      "geo": { "lng": 118.857, "lat": 31.927 },
      "layout": "1B1H",
      "area_sqm": 45.0,
      "orientation": "S",
      "floor": { "current": 15, "total": 26 },
      "rent_monthly": 2380,
      "service_fee_pct": 0.08,
      "market_price_ref": 3200,
      "house_quality": { "comfort":4, "green":3, "smart":5, "safety":4 },
      "amenities": ["AC","FRIDGE","WASHER","WIFI","SMART_LOCK","ELEVATOR"],
      "photos": [ /* … ≥ 6 张 … */ ],
      "access_mode": "SELF",
      "cert_no": "宁住保字〔2024〕第 0188 号"
    }
  ]
}

响应(部分成功)

{
  "accepted": 198,
  "rejected": 2,
  "results": [
    {
      "external_id": "ZR-NJ-2024-00188",
      "listing_id": "L-JS-NJ-9f3a...",
      "status": "PENDING_REVIEW"
    },
    {
      "external_id": "ZR-NJ-2024-00200",
      "status": "REJECTED",
      "error": { "code": "E_PRICE_REDLINE", "message": "租金 ¥3680 超出江宁区一室一厅红线 ¥3400" }
    }
  ]
}

4.2 房源状态变更

PUT /v1/listings/{listing_id}/status 上架 / 暂存 / 下架
PUT /v1/listings/L-JS-NJ-9f3a.../status

{
  "action": "DELIST",        // LIST | HOLD | DELIST
  "reason": "已成交",
  "effective_at": "2026-06-10T00:00:00+08:00"
}

4.3 上报运营事件

POST /v1/listings/{listing_id}/events 动态字段推送
POST /v1/listings/L-JS-NJ-9f3a.../events

{
  "type": "CONTRACT_SIGNED",
  "occurred_at": "2026-06-05T14:32:00+08:00",
  "payload": {
    "filing_no": "NJ-FL-2026-0010088",
    "tenant_hash": "sha256:b1f...",
    "term_months": 12,
    "monthly_rent": 2380,
    "deposit": 0,           // 省级标准:免押金
    "insurance": ["home_property","switch_rental"]
  }
}

4.4 查询房源

GET /v1/listings?operator_id=&status=&page=&page_size= 本机构房源列表

4.5 三方备案接口

POST /v1/filings 提交租赁合同至住建备案系统

平台代为对接住建厅备案系统;机构推送即视为已尽备案义务,回执 5 分钟内返回。

5 价格红线校验

每条房源在 batchUpsert 时同步校验,校验源 = 江苏住房租赁数据治理委员会发布的"区域 × 户型 × 季度"上限表。

GET /v1/redline?city=南京市&district=江宁区&layout=1B1H 查询当前红线
{
  "city": "南京市",
  "district": "江宁区",
  "layout": "1B1H",
  "redline_monthly": 3400,
  "market_avg": 3120,
  "updated_at": "2026-06-01",
  "audit_by": ["清华大学","东南大学","省社科院"]
}
注:价格红线每季度由数据治理委员会调整一次;机构如对红线有异议,可通过 /v1/redline/disputes 提交申诉,60 天内由第三方审计组裁决。

6 备案回流 Webhook

住建系统回执由平台中转至机构端。机构在控制台配置 callback URL,平台用与请求签名相同的 HMAC 算法签名后投递,3 次重试。

事件类型

event说明
listing.approved房源通过住建审核,已上架
listing.rejected审核未通过
filing.confirmed合同备案号已生效
redline.updated所辖区域红线发生变化(建议存量复核)
compliance.alert合规预警(连续投诉 / 评分过低 / 违规收费)

Payload 示例

POST https://ziroom.com/hooks/bzf-jiangsu
X-BZF-Signature: sha256=...

{
  "event": "filing.confirmed",
  "occurred_at": "2026-06-05T14:35:12+08:00",
  "data": {
    "listing_id": "L-JS-NJ-9f3a...",
    "filing_no": "NJ-FL-2026-0010088",
    "valid_until": "2027-06-04"
  }
}

7 错误码

HTTPcode含义处置
400E_VALIDATION字段格式错误按返回 details 修正
400E_PRICE_REDLINE租金超红线调整租金,或 /redline/disputes 申诉
400E_PHOTO_INSUFFICIENT图片少于 6 张补图后重推
400E_CERT_NO_MISSING保租房认定文号缺失或失效联系区住建局核发
401E_AUTHtoken 失效重取 token
403E_SCOPEscope 不足升级机构资质
409E_DUPLICATE_EXTIDexternal_id 与已有冲突使用 PUT 更新
422E_HOUSE_QUALITY_LOW好房子评级 < 3整改后重报
429E_RATE_LIMIT触发限流退避重试,或申请升级
503E_REDLINE_AUDIT红线接口审计中稍后 5 分钟重试

8 接入 SLA 与流程

承诺 6–8 周完成接入。流程:

  1. Week 0–1:资质审核(白名单备案 / 网安等保 / 数据安全协议)
  2. Week 2:颁发沙箱凭证 + 1V1 技术对接群
  3. Week 3–4:字典映射 + 接口联调 + 单元测试
  4. Week 5:UAT 全链路演练(含 redline / webhook / 备案回流)
  5. Week 6:合规审计 + 隐私评估(PIA)+ 安全渗透测试
  6. Week 7–8:灰度(10% 房源)→ 全量切流 → 住建备案

运行期 SLA

指标目标值违约赔付
接口可用性(生产)≥ 99.9% / 月承建方付月费 5% / 0.1%
批量推送 P99 延迟≤ 1500 ms
Webhook 投递成功率≥ 99%(3 次重试内)失败队列保留 7 天
备案回执时延≤ 5 min(住建系统时延除外)

9 Excel 模板(非 API 渠道)

面向尚未具备 API 能力的小型机构 / 国资项目方,提供统一 Excel 模板(与上述字典字段 1:1 对应)。机构填写后上传,平台后台批量导入。

过渡安排:Excel 渠道仅限接入首年使用,第二年起强制 API 化(豁免:年存量 < 200 套的微型机构)。

归口部门:江苏省住房和城乡建设厅 · 住房租赁监管处

承建方:贝壳找房(保租房统一服务平台)

审计与公示:清华大学公共管理学院 · 东南大学 · 江苏省社科院 · 江苏省房地产业协会

反馈:api-feedback@bzf.jiangsu.gov.cn · 工单系统 → 12345 政务直达

本文档基于 V25 行业标准编制;正式发布以省住建厅后续发布版本为准(具体发布时间随政策节奏而定)。