首页 / 文档中心 / 宠物喂食器（ODM 案例） / 设置模块
设置模块
设置鉴权接口文档
概览
- 基础路径: /api
- 文档范围: 鉴权路由中的 settings 模块接口
- 鉴权方式: 请求头 X-Token
- Content-Type: application/json
鉴权头
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| X-Token | string | 是 | 用户登录后获得的 JWT Token |
设置对象字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| userId | integer | 用户 ID |
| feedReminder | boolean | 喂食提醒开关 |
| lowFoodReminder | boolean | 余粮不足提醒开关 |
| offlineReminder | boolean | 离线提醒开关 |
| lowBatteryReminder | boolean | 低电量提醒开关 |
| soundEnabled | boolean | 声音提醒开关 |
| noDisturb | boolean | 勿扰模式开关 |
| noDisturbStart | string | 勿扰开始时间，格式 HH:mm |
| noDisturbEnd | string | 勿扰结束时间，格式 HH:mm |
| biometricEnabled | boolean | 生物识别开关 |
1. 获取用户设置
- 路径: /api/settings/get
- 方法: POST
- 是否鉴权: 是
请求 Body
无业务参数，可传空对象：
{}
成功响应示例
{
"code": 200,
"msg": "操作成功",
"data": {
"userId": 1,
"feedReminder": true,
"lowFoodReminder": true,
"offlineReminder": true,
"lowBatteryReminder": true,
"soundEnabled": true,
"noDisturb": false,
"noDisturbStart": "22:00",
"noDisturbEnd": "08:00",
"biometricEnabled": false
}
}
失败响应示例
{
"code": 500,
"msg": "获取设置失败",
"data": null
}
2. 更新用户设置
- 路径: /api/settings/update
- 方法: POST
- 是否鉴权: 是
请求 Body 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| feedReminder | boolean | 否 | 是否开启喂食提醒 |
| lowFoodReminder | boolean | 否 | 是否开启余粮不足提醒 |
| offlineReminder | boolean | 否 | 是否开启离线提醒 |
| lowBatteryReminder | boolean | 否 | 是否开启低电量提醒 |
| soundEnabled | boolean | 否 | 是否开启声音提醒 |
| noDisturb | boolean | 否 | 是否开启勿扰模式 |
| noDisturbStart | string | 否 | 勿扰开始时间，非空时才会覆盖 |
| noDisturbEnd | string | 否 | 勿扰结束时间，非空时才会覆盖 |
| biometricEnabled | boolean | 否 | 是否开启生物识别 |
请求示例
{
"feedReminder": true,
"lowFoodReminder": true,
"offlineReminder": false,
"lowBatteryReminder": true,
"soundEnabled": false,
"noDisturb": true,
"noDisturbStart": "23:00",
"noDisturbEnd": "07:00",
"biometricEnabled": true
}
成功响应示例
{
"code": 200,
"msg": "设置已保存",
"data": null
}
失败响应示例
{
"code": 400,
"msg": "参数错误",
"data": null
}
{
"code": 400,
"msg": "保存设置失败",
"data": null
}
{
"code": 500,
"msg": "获取设置失败",
"data": null
}
附录
说明
- settings/get 当前不读取业务请求体，空对象或空 body 均可。
- settings/update 为部分更新，只会覆盖请求中显式传入的字段。
这份文档没解决你的问题？联系我们，技术工程师直接对接。