elefymove
文档

开发者文档

ElefyMove Open API 的指南与参考。

这些指南目前仅提供英文版。

Endpoints

方法端点权限范围用途
POST/api/public/v1/listingslistings:write提交新房源进入审核，内容可使用我们支持的 9 种语言中的任意几种。
GET/api/public/v1/listingslistings:read列出该密钥拥有的全部房源及其当前审核状态。
GET/api/public/v1/listings/{externalId}listings:read按你指定的外部 ID 读取你的某个房源。
PATCH/api/public/v1/listings/{externalId}listings:write更新你的房源，未提交的字段保持不变。
DELETE/api/public/v1/listings/{externalId}listings:write将你的房源下架。
POST/api/public/v1/listings/{externalId}/photoslistings:write为房源添加一张照片，无需完整更新。图片会由 ElefyMove 抓取并重新托管——你的 URL 不会被直接存储。
DELETE/api/public/v1/listings/{externalId}/photos/{photoId}listings:write从房源中移除一张照片。如果会使已发布房源的照片数低于最低要求，将返回 400 拒绝。

How listings work

  • You identify each listing by your own externalId — ElefyMove never asks you to store its internal ids.
  • Content is multilingual: submit any subset of the 9 supported locales, and ElefyMove serves the right language to each visitor.
  • New and updated listings pass moderation before going live. Subscribe to listing.approved / listing.rejected webhooks instead of polling for status.
  • PATCH is a partial update — any field you omit is left unchanged. DELETE unlists (it does not erase history).
  • Add or remove a single photo without a full PATCH round-trip. A photo you submit as a URL is fetched and re-hosted by ElefyMove — your URL is never stored or linked directly.
  • Removing a photo is refused with a MIN_PHOTOS_REQUIRED 400 if it would drop a currently-published listing below the minimum photo count.
  • Listings sourced through the API link back to their canonical page on elefymove.com.

Reference data

These routes need no scope — any valid key can read them. They expose the exact enum, locale, and currency values POST /listings validates against, and the canonical location hierarchy, so you never have to hard-code or guess them:

方法端点权限范围用途
GET/api/public/v1/locations任意有效密钥读取省 → 区/县 → 片区的规范地理位置树。
GET/api/public/v1/locations/search任意有效密钥在规范地理位置层级中进行输入联想搜索。
GET/api/public/v1/reference/property-types任意有效密钥房源可接受的全部房产类型取值。
GET/api/public/v1/reference/amenities任意有效密钥设施字段必须遵守的长度与数量限制——设施是自由文本，并非固定目录。
GET/api/public/v1/reference/locales任意有效密钥房源翻译内容可接受的全部语言代码。
GET/api/public/v1/reference/currencies任意有效密钥房源价格使用的货币。ElefyMove 仅服务泰国，因此始终为泰铢（THB）。

amenities has no fixed catalog — it is free text validated only by a count and a per-item length limit. GET /reference/amenities returns those limits with an empty values array and freeText: true; do not treat the empty array as "no amenities allowed".