从流程出发，而不是从接口数量出发。
告诉我们哪些系统与租赁记录需要流转。上线前，我们会确认受支持的范围、访问规则与事件流。
保持受支持记录同步
读取经批准的租赁流程记录，而不开放对其余工作区的访问。
当前契约中的数据族
- Deals
- Properties
- Contacts
响应重要变更
通过签名 Webhook 接收受支持的交易、付款、文件、相关方、任务与合规变更。
事件族
- compliance
- deal
- document
- party
- payment
- task
掌控每一把密钥
按权限、接口以及可选的 IP 白名单限制每把密钥，并在需要时吊销或设置有效期。
了解发生了什么
在监控集成或排查故障时，查看 API 使用记录与 Webhook 投递历史。
Enterprise 集成访问如何开通
- 1
确认受支持范围
说明集成所需的系统、记录与操作。我们确认哪些内容纳入经批准的外部契约。
- 2
创建受限的公司密钥
由机构管理员创建限定公司范围的只读密钥，并设定获批接口、有效期与可选 IP 白名单。
- 3
连接并监控
每个请求都使用 API 密钥进行认证，校验 Webhook 签名，并借助可用日志监控连接状况。
掌控边界
只给每个集成它真正需要的访问权限。
公司隔离、只读访问、接口白名单、有效期与可选 IP 限制，共同把每个集成约束在其获批范围内。
- 限定公司范围
- 只读访问
- 接口白名单
- 可选 IP 白名单
- 有效期与吊销
用 API 处理记录，用 Webhook 处理变更。
外部 API
读取为贵方集成开放的受支持记录。认证通过 HTTPS 上的公司 API 密钥完成。
签名 Webhook
无需轮询即可接收受支持的变更。每次投递都包含事件标识、时间戳与用于校验的 HMAC-SHA256 签名。
投递历史与重试机制有助于贵方团队排查失败的 Webhook 调用。
依照经批准的集成契约进行开发。
上线期间，贵方技术团队将收到该集成经批准的资源与事件范围、认证要求、错误行为、限额以及 Webhook 校验指引。
经批准的 API 范围
仅呈现为贵机构集成确认的资源与方法。
认证与限额
获取上线适用的公司密钥要求、权限、错误行为与限额。
Webhook 校验
配置经批准的接收地址，校验签名负载，并了解投递与重试行为。
常见问题
- 自助订阅方案是否包含 API 访问？
- API 密钥与 Webhook 属于 Enterprise 能力。请联系销售并说明所需的系统与流程，以便在上线前确认受支持范围。
- 集成如何进行认证？
- 由机构管理员创建限定公司范围的 API 密钥。集成在文档所述的 HTTPS 请求头中发送该密钥；它不会被换成用户 JWT。
- 可以限制 API 密钥的访问范围吗？
- 可以。密钥可按权限、获批接口、有效期与可选 IP 白名单加以限制，不再需要时即可吊销。
- 我们可以连接哪些记录？
- 可用资源取决于为贵方上线确认的外部契约。技术交接材料仅列出为贵机构集成批准的资源与方法。
- Webhook 调用如何受到保护？
- TenancyDesk 将受支持事件发送至 HTTPS 地址，并附带带时间戳的 HMAC-SHA256 签名。贵方集成需在处理负载前校验签名。
- API 是否会取代 Property Finder 或 Bayut 导入？
- 不会。Property Finder 使用贵机构自己的 API 凭据，Bayut / dubizzle 则通过 Profolio 的 Excel 文件导入。Enterprise API 用于与贵方内部系统的获批连接。各平台的连接方式请见集成页面。
- 能否在常规免费试用期内测试 API？
- 14 天试用涵盖 Professional 产品体验。API 密钥与 Webhook 由 Enterprise 销售单独确定范围。