跳转到主要内容

REST API

必威是什么Home Assistant与web前端在同一个端口上提供RESTful API。(默认端口号为8123)。

如果你不使用前端在您的设置中,然后您需要添加api组件到你的configuration.yaml文件。

  • http://IP_ADDRESS:8123/是一个控制家庭助理的界面。必威是什么
  • http://IP_ADDRESS:8123/api/是一个RESTful API。

API只接受并返回JSON编码的对象。

所有API调用都必须伴有头文件授权:无记名ABCDEFGH,在那里ABCDEFGH由您的令牌替换。通过使用web浏览器登录到前端,您可以获得一个令牌(“长期访问令牌”),并进入你的资料http://IP_ADDRESS:8123/profile

使用Home Assistant Rest API有多种方式。必威是什么一个是与旋度

旋度- x得到
- h“授权:无记名ABCDEFGH”
- h“application / json内容类型:
http://IP_ADDRESS:8123/ENDPOINT

另一种选择是使用Python和请求模块。

请求进口得到

url“http://localhost: 8123 /端点”

“授权”“不记名ABCDEFGH”
“内容类型”“application / json”


响应得到url
打印响应文本

另一种选择是使用Restful命令集成在家庭助理必威是什么自动化或脚本。

turn_light_on
urlhttp/ / localhost8123 / api /州/ light.study_light
方法帖子

授权“不记名ABCDEFGH”
内容类型“application / json”
有效载荷“{”状态”:“on”}’

成功的呼叫将返回状态码200或201。其他可以返回的状态码有:

  • 400(错误请求)
  • 401(未经授权)
  • 404(未找到)
  • 405(不允许使用方法)

行动

API支持以下操作:

得到
/ api /
得到
/ api /配置
得到
/ api /事件
得到
/ api /服务
得到
/ api /历史/时间/ <时间戳>
得到
/ api /日志/ <时间>
得到
/ api /州
得到
/ api /州/ < entity_id >
得到
/ api / error_log
得到
/ api / camera_proxy / <相机entity_id >
帖子
/ api /州/ < entity_id >
帖子
/ api /事件/ < event_type >
帖子
/ api /服务/ <域> / <服务>
帖子
/ api /模板
帖子
/ api / config / / check_config核心
Baidu