REST API / DOCUMENTATION
粤医美 Open API
v1 · Base URL: https://yueyimei.com/wp-json/yueyimei/v1
数据使用请遵守粤医美服务协议。本 API 为只读公开接口,无需鉴权。商业用途请联系 API 商用合作。
SECTION 01 / 03 · OVERVIEW
概述
| Base URL | https://yueyimei.com/wp-json/yueyimei/v1 |
|---|---|
| 协议 | HTTPS · JSON |
| 鉴权 | 无需鉴权(只读公开接口) |
| 速率限制 | 5 req/s · 突发上限 10 · 超限返回 HTTP 429 |
| 字符编码 | UTF-8 |
| 日期格式 | ISO 8601 (YYYY-MM-DD 或 YYYY-MM-DDTHH:MM:SS+08:00) |
通用响应结构
{
"status": "ok",
"data": { ... },
"meta": {
"api_version": "v1",
"generated_at": "2026-05-17T12:00:00+08:00",
"source": "yueyimei.com",
"disclaimer": "数据仅供参考,不构成医疗建议。",
"license": "数据使用请遵守粤医美服务协议。",
"docs_url": "https://yueyimei.com/api-docs/"
}
}
错误响应
{
"code": "clinic_not_found",
"message": "机构未找到",
"data": { "status": 404 }
}
| HTTP 状态码 | 含义 |
|---|---|
200 | 请求成功 |
400 | 参数有误(类型不匹配、值超出范围) |
404 | 资源不存在 |
429 | 请求频率超限 |
500 | 服务器内部错误 |
SECTION 02 / 03 · ENDPOINTS
端点列表
机构列表,支持多维筛选与分页。
请求参数
| 参数 | 类型 | 默认 | 说明 |
|---|---|---|---|
city |
string | — | 城市 slug(如 shenzhen) |
district |
string | — | 行政区 slug(如 futian) |
grade |
string | — | AI 可见度等级,枚举值:A / B / C / D |
orderby |
string | date |
排序方式:date(入库时间降序)/ score(AI 评分降序) |
page |
integer | 1 |
页码,最小值 1 |
per_page |
integer | 20 |
每页条数,范围 1–100 |
响应头
| Header | 说明 |
|---|---|
X-YYM-Total | 符合条件的机构总数 |
X-YYM-TotalPages | 总页数 |
示例请求
curl "https://yueyimei.com/wp-json/yueyimei/v1/clinics?city=shenzhen&grade=A&per_page=5"
示例响应
{
"status": "ok",
"data": {
"total": 42,
"page": 1,
"per_page": 5,
"total_pages": 9,
"clinics": [
{
"id": "SZ-FT-0001",
"slug": "example-clinic",
"name": "示例医疗美容门诊部",
"short_name": "示例门诊",
"city": "深圳",
"district": "福田",
"medical_grade":"医疗美容门诊部",
"certification":"deep",
"founding_year": 2018,
"doctor_count": 5,
"ai_score": {
"score": 85,
"grade": "B",
"evaluated_at": "2026-05-01"
},
"last_verified": "2026-05-10",
"canonical_url": "https://yueyimei.com/clinic/example-clinic/"
}
]
},
"meta": { "api_version": "v1", "..." : "..." }
}
单机构完整详情,包含执照信息、地址、联系方式、医师列表。
路径参数
| 参数 | 类型 | 说明 |
|---|---|---|
slug |
string | 机构页面 slug(URL 中的英文路径段) |
示例请求
curl "https://yueyimei.com/wp-json/yueyimei/v1/clinics/example-clinic"
示例响应(detail 额外字段)
{
"status": "ok",
"data": {
"id": "SZ-FT-0001",
"slug": "example-clinic",
"name": "示例医疗美容门诊部",
"...",
"license": {
"unified_credit_code": "91440300XXXXXXXXXX",
"medical_license_no": "粤深卫医机构备字〔2018〕第XXXX号",
"medical_license_url": "https://example.com/license.jpg"
},
"company": {
"legal_representative": "张三",
"registered_capital": "500万元人民币",
"founding_date": "2018-06-01"
},
"address": {
"full": "广东省深圳市福田区XXX路X号",
"latitude": 22.5431,
"longitude": 114.0579
},
"contact": {
"phone": "0755-XXXXXXXX"
},
"doctors": [
{
"name": "李四",
"title": "主治医师",
"license_no": "XXXXXXXXXXXXXXXXXX",
"url": "https://yueyimei.com/doctor/lisi/"
}
]
},
"meta": { "api_version": "v1", "..." : "..." }
}
错误:机构不存在
HTTP/1.1 404 Not Found
{
"code": "clinic_not_found",
"message": "机构未找到",
"data": { "status": 404 }
}
城市统计,返回各城市收录机构数量及档案页链接。
示例请求
curl "https://yueyimei.com/wp-json/yueyimei/v1/cities"
示例响应
{
"status": "ok",
"data": {
"total_clinics": 312,
"cities": [
{
"slug": "shenzhen",
"name": "深圳",
"clinic_count": 186,
"archive_url": "https://yueyimei.com/shenzhen/"
},
{
"slug": "guangzhou",
"name": "广州",
"clinic_count": 78,
"archive_url": "https://yueyimei.com/guangzhou/"
}
]
},
"meta": { "api_version": "v1", "..." : "..." }
}
SECTION 03 / 03 · DATA FIELDS
机构字段说明
摘要字段(列表 + 详情共有)
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 粤医美机构 ID(格式:CITY-DISTRICT-NNNN),全球唯一标识符 |
slug | string | URL slug,用于构建 /clinic/{slug}/ 路径 |
name | string | 机构全称(来源:医疗机构执业许可证) |
short_name | string | null | 机构常用简称 |
city | string | null | 所在城市名称 |
district | string | null | 所在行政区名称 |
medical_grade | string | null | 机构类型(如:医疗美容门诊部 / 医疗美容医院) |
certification | string | null | 粤医美认证状态:deep(深度认证)/ basic(基础认证) |
founding_year | integer | null | 注册成立年份 |
doctor_count | integer | null | 在案主诊医师数 |
ai_score |
object | null |
AI 可见度评分对象:score (0–100 整数) · grade (A/B/C/D) · evaluated_at (ISO date)
|
last_verified | string | null | 数据最近核验日期(ISO 8601) |
canonical_url | string | 机构详情页正规 URL |
详情额外字段
| 字段 | 类型 | 说明 |
|---|---|---|
license.unified_credit_code | string | null | 统一社会信用代码(18位) |
license.medical_license_no | string | null | 医疗机构执业许可证号 |
license.medical_license_url | string | null | 执业许可证扫描件 URL |
company.legal_representative | string | null | 法定代表人姓名 |
company.registered_capital | string | null | 注册资本 |
company.founding_date | string | null | 注册成立日期(YYYY-MM-DD) |
address.full | string | null | 完整地址 |
address.latitude | float | null | 纬度(WGS84) |
address.longitude | float | null | 经度(WGS84) |
contact.phone | string | null | 联系电话 |
doctors[] |
array | null |
医师数组,每项包含:name · title · license_no · url
|
NOTICE / 数据说明
所有 null 字段在响应中会被省略(不会出现 "field": null)。AI 可见度评分基于对 DeepSeek / Kimi / 豆包 / 腾讯元宝 / 百度 AI 五平台的公开检索测试,评分每月更新,不代表机构服务质量保证。数据来源:卫健委公示系统 / 信用中国 / NMPA。