把 hanye 接进你自己的系统:ERP、订单、大屏、自动化脚本 —— 一份 OpenAPI 3.1 契约 + 官方 Python SDK 全搞定。
标准契约文件,可直接导入 Apifox / Postman / Swagger UI。运行中的监控台也可随时拉取最新版:http://监控台地址:17890/api/public/v1/openapi.json
包名 hanye_client,覆盖设备、文件库、队列、耗材等常用对象。解压后 pip install -e . 即装,或直接把 hanye_client 目录丢进 PYTHONPATH。
在「软件设置 → 扩展中心 → 开放 API」创建密钥。作用域分级 read ⊂ submit ⊂ control——只读的钥匙永远干不了控制的事。
两种请求头任选其一:
# 方式一:Bearer Token Authorization: Bearer hy_… # 方式二:API Key 请求头 X-API-Key: hy_…
| 作用域 | 能做什么 |
|---|---|
| read | 查询设备状态、任务、耗材、文件 |
| submit | read + 提交任务、入队 |
| control | submit + 暂停 / 恢复 / 停止等控制 |
pip install requests && pip install -e .from hanye_client import Client client = Client( base_url="http://192.168.1.10:17890", api_key="hy_xxx", ) print(client.devices.list())
契约 + SDK 都打包好了,下载就能开工。
更多接口细节见文档中心 · OpenAPI 与 SDK 篇;宿主 HTTP API 之外,插件也各有 API,可经 Moonraker HTTP 代理透传。