API接口文档
晶速医疗管理系统提供RESTful API接口，支持JSON数据格式。所有接口都需要在请求头中包含API密钥进行身份验证。
基础URL：
https://api.nhip.com.cn/v1
身份验证
所有API请求都需要在HTTP Header中包含API密钥：
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json创建客户
POST
/customers
创建新的客户档案信息
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 客户姓名 |
| phone | string | 是 | 联系邮箱 |
| gender | integer | 否 | 性别：0-未知，1-男，2-女 |
| birthday | string | 否 | 出生日期，格式：YYYY-MM-DD |
| address | string | 否 | 联系地址 |
| tags | array | 否 | 客户标签ID列表 |
请求示例
{
"name": "张三",
"phone": "13800138000",
"gender": 1,
"birthday": "1990-01-01",
"address": "北京市朝阳区",
"tags": [1, 2, 3]
}响应示例
{
"code": 200,
"message": "success",
"data": {
"id": 1001,
"name": "张三",
"phone": "13800138000",
"created_at": "2024-01-01T00:00:00Z"
}
}更新客户信息
PUT
/customers/{id}
更新指定客户的信息
路径参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | integer | 客户ID |
请求参数
与创建客户接口相同，所有字段都是可选的
客户列表查询
GET
/customers
查询客户列表，支持分页和筛选
查询参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | integer | 否 | 页码，默认1 |
| page_size | integer | 否 | 每页数量，默认20 |
| keyword | string | 否 | 搜索关键词（姓名或手机号） |
| tag_id | integer | 否 | 标签ID筛选 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"total": 100,
"page": 1,
"page_size": 20,
"items": [
{
"id": 1001,
"name": "张三",
"phone": "13800138000",
"gender": 1,
"created_at": "2024-01-01T00:00:00Z"
}
]
}
}创建诊疗记录
POST
/diagnosis
为客户创建新的诊疗记录
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| customer_id | integer | 是 | 客户ID |
| diagnosis_type | integer | 是 | 诊断类型ID |
| tooth_position | string | 否 | 牙位，如：11,12,13 |
| description | string | 否 | 诊断描述 |
| doctor_id | integer | 是 | 医生ID |
诊疗划价
POST
/diagnosis/price
为诊疗记录进行划价处理
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| diagnosis_id | integer | 是 | 诊疗记录ID |
| items | array | 是 | 划价项目列表 |
| discount_type | integer | 否 | 优惠类型：0-无优惠，1-折扣，2-减免 |
| discount_value | number | 否 | 优惠值 |
请求示例
{
"diagnosis_id": 1001,
"items": [
{
"item_id": 1,
"quantity": 1,
"price": 100.00
}
],
"discount_type": 1,
"discount_value": 0.9
}创建支付订单
POST
/payments
创建新的支付订单
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| customer_id | integer | 是 | 客户ID |
| amount | number | 是 | 支付金额 |
| payment_method | integer | 是 | 支付方式：1-支付宝，2-微信，3-美团，4-现金 |
| order_type | integer | 是 | 订单类型：1-诊疗，2-商品，3-充值 |
| order_id | integer | 是 | 关联订单ID |
美团核销
POST
/payments/meituan/verify
核销美团团购券
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| coupon_code | string | 是 | 美团券码 |
| customer_id | integer | 是 | 客户ID |
| amount | number | 是 | 核销金额 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"verify_id": 1001,
"coupon_code": "MT123456789",
"amount": 100.00,
"status": "verified"
}
}创建预约
POST
/appointments
创建新的预约记录
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| customer_id | integer | 是 | 客户ID |
| doctor_id | integer | 是 | 医生ID |
| appointment_time | string | 是 | 预约时间，格式：YYYY-MM-DD HH:mm:ss |
| type | integer | 是 | 预约类型：1-初诊，2-复诊 |
| remark | string | 否 | 备注信息 |
二维码生成
POST
/marketing/qrcode
生成营销二维码
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | integer | 是 | 二维码类型：1-客户推荐，2-活动推广 |
| activity_id | integer | 否 | 活动ID（活动推广类型必填） |
| referee_id | integer | 否 | 推荐人ID（客户推荐类型必填） |
响应示例
{
"code": 200,
"message": "success",
"data": {
"qrcode_url": "https://qrcode.nhip.com.cn/xxx.png",
"qrcode_id": "QR20240101001"
}
}错误码说明
| 错误码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 401 | 未授权，API密钥无效 |
| 403 | 无权限访问 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |