Gladys Assistant API参考手册：完整REST接口使用指南

Gladys Assistant API参考手册：完整REST接口使用指南

【免费下载链接】Gladys A privacy-first, open-source home assistant 项目地址: https://gitcode.com/gh_mirrors/gl/Gladys

Gladys Assistant是一款隐私优先的开源智能家居助手，提供了强大的REST API接口，让开发者能够轻松集成和控制各种智能设备。本指南将详细介绍Gladys API的核心功能和使用方法。

🔍 Gladys Assistant API概述

Gladys Assistant的API接口设计简洁直观，支持设备管理、场景控制、用户认证等核心功能。所有API请求都需要通过身份验证，确保数据安全。

📋 API主要功能模块

设备管理接口

• GET /api/v1/device - 获取所有设备列表
• POST /api/v1/device - 创建设备
• PUT /api/v1/device/:device_selector - 更新设备信息
• DELETE /api/v1/device/:device_selector - 删除设备

场景控制接口

• GET /api/v1/scene - 获取所有场景
• POST /api/v1/scene - 创建新场景
• PUT /api/v1/scene/:scene_selector - 更新场景配置
• POST /api/v1/scene/:scene_selector/start - 启动场景

用户认证接口

• POST /api/v1/login - 用户登录
• POST /api/v1/signup - 用户注册
• POST /api/v1/forgot-password - 密码重置

🚀 快速开始使用API

1. 获取访问令牌

首先需要通过登录接口获取访问令牌：

curl -X POST https://your-gladys-instance/api/v1/login \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"yourpassword"}'

2. 调用设备接口

使用获取的令牌调用设备管理接口：

curl -X GET https://your-gladys-instance/api/v1/device \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

🔧 核心API详解

设备状态管理

Gladys Assistant支持实时获取设备状态，包括开关状态、温度、湿度等传感器数据。

场景自动化

通过场景API可以实现复杂的自动化逻辑，如定时任务、设备联动等。

📊 数据格式规范

所有API请求和响应都采用JSON格式，确保数据交换的一致性和可读性。

请求头配置

• Content-Type: application/json
• Authorization: Bearer <token>

💡 最佳实践建议

1. 错误处理：所有API调用都应包含适当的错误处理机制
2. 频率限制：注意API调用频率，避免触发限制
3. 数据验证：在发送请求前验证数据格式

🛠️ 高级功能

WebSocket实时通信

除了REST API，Gladys还提供WebSocket接口，用于实时接收设备状态更新。

批量操作支持

部分接口支持批量操作，提高数据处理效率。

🔒 安全注意事项

• 妥善保管访问令牌
• 使用HTTPS加密通信
• 定期轮换API密钥

通过掌握Gladys Assistant的API接口，开发者可以构建强大的智能家居应用，实现设备自动化控制和数据管理。

【免费下载链接】Gladys A privacy-first, open-source home assistant 项目地址: https://gitcode.com/gh_mirrors/gl/Gladys