跳过主要内容

REST API

必威是什么家庭助理在与Web Frontend同一端口上提供了一个安息的API。(默认端口是端口8123)。

如果您不使用前端在您的设置中,您需要添加API一体化给你configuration.yaml文件。

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

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

所有API的电话都必须伴随着标题授权:持有人ABCDEFGH, 在哪里abcdefgh被您的令牌取代。您可以使用Web浏览器登录前端,然后去获得令牌(“长寿命访问令牌”)你的个人资料http:// ip_address:8123/profile

有多种方法可以消费家庭助理REST API。必威是什么一个与卷曲

卷曲-x获取\ \
-H“授权:持有人Abcdefgh”\ \
-H“内容类型:应用程序/JSON”\ \
http:// ip_address:8123/端点

另一个选择是使用Python和要求模块。

要求进口得到

URL=“ http:// localhost:8123/endpoint”
标题={
“授权”“持票人abcdefgh”,,,,
“内容类型”“应用程序/JSON”,,,,
}

回复=得到((URL,,,,标题=标题
打印((回复文本

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

turn_light_on
URLhttp// Localhost8123/api/states/light.study_light
方法邮政
标题
授权“持票人abcdefgh”
内容类型'应用程序/json'
有效载荷'{“ state”:“ on”}'

成功的电话将返回状态代码200或201。其他可以返回的状态代码是:

  • 400(不良要求)
  • 401(未经授权)
  • 404(找不到)
  • 405(不允许的方法)

动作

API支持以下操作:

得到
/api/
得到
/api/config
得到
/API/事件
得到
/API/服务
得到
/api/history/ofient/<时间戳>
得到
/api/logbook/
得到
/api/state
得到
/api/states/
得到
/api/error_log
得到
/api/camera_proxy/<摄像机entity_id>
得到
/API/日历
得到
/api/calendars/<日历entity_id>
邮政
/api/states/
邮政
/api/events/
邮政
/api/services//<服务>
邮政
/API/模板
邮政
/api/config/core/check_config
邮政
/api/intent/hander
Baidu