只产健康 API 文档

快速开始

注册账号：调用 POST /api/auth/register 注册获取 API Key
获取额度：新用户自动获得 100 次免费调用额度
开始调用：在请求头添加 X-API-Key: your_key_here
查看余额：调用 GET /api/admin/quota 查看剩余额度

基础认证接口

用户注册

POST /api/auth/register 无需认证

请求参数 (JSON)

参数名	类型	必填	说明
email	string	是	邮箱地址（登录账号）
password	string	是	密码（6位以上）
company	string	否	公司/机构名称
phone	string	否	联系电话

curl -X POST https://api.zhichanjiankang.com/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "developer@example.com", "password": "your_password", "company": "XX科技有限公司"}'

# Python 示例
import requests

response = requests.post(
    "https://api.zhichanjiankang.com/api/auth/register",
    json={"email": "developer@example.com",
          "password": "your_password"}
)
print(response.json())

// JavaScript 示例
const response = await fetch('https://api.zhichanjiankang.com/api/auth/register', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ email: 'dev@example.com', password: 'pass123' })
});
const data = await response.json();

成功响应

{
  "code": 0,
  "message": "注册成功",
  "data": {
    "user_id": 1,
    "api_key": "a1b2c3d4e5f6...",
    "quota": 100
  }
}

用户登录

POST /api/auth/login 无需认证

参数名	类型	必填	说明
email	string	是	邮箱地址
password	string	是	密码

成功响应

{
  "code": 0,
  "data": {
    "user_id": 1,
    "email": "developer@example.com",
    "keys": [{"name": "默认Key", "key": "a1b2c3...", "quota": 95}]
  }
}

五运六气接口

八字分析

GET /api/v1/yunqi/bazi/{year}/{month}/{day} 需要认证

参数名	位置	类型	必填	说明
X-API-Key	Header	string	是	API密钥
year	Path	string	是	出生年（4位数字）
month	Path	string	是	出生月（1-12）
day	Path	string	是	出生日（1-31）

curl https://api.zhichanjiankang.com/api/v1/yunqi/bazi/1990/8/15 \
  -H "X-API-Key: your_api_key_here"

今日五运六气

GET /api/v1/yunqi/now 需要认证

获取当前时段的五运六气状态

curl https://api.zhichanjiankang.com/api/v1/yunqi/now \
  -H "X-API-Key: your_api_key_here"

知识检索接口

中医知识语义搜索

GET /api/v1/knowledge/search?q={关键词} 需要认证

参数名	位置	类型	必填	说明
X-API-Key	Header	string	是	API密钥
q	Query	string	是	搜索关键词
top_k	Query	int	否	返回结果数量，默认3

curl "https://api.zhichanjiankang.com/api/v1/knowledge/search?q=脾胃虚弱&top_k=5" \
  -H "X-API-Key: your_api_key_here"

账户管理接口

查看套餐

GET /api/plans 无需认证

curl https://api.zhichanjiankang.com/api/plans

查看配额

GET /api/admin/quota 需要认证

curl https://api.zhichanjiankang.com/api/admin/quota \
  -H "X-API-Key: your_api_key_here"

错误码说明

400 请求参数错误

401 API Key无效或缺失

403 无权访问

404 接口不存在

429 配额已用完

500 服务器内部错误

常见问题

Q: 如何获取API Key?

调用注册接口，成功后会返回您的API Key，请妥善保管。

Q: 免费额度用完怎么办?

可以购买付费套餐升级额度，联系客服获取企业报价。

Q: 调用频率有限制吗?

为保障服务稳定性，单Key每秒最多10次调用。