Hamibot REST API 快速上手
API 基础信息
- 基础地址:
https://api.hamibot.com/ - 国内备用:
https://api.hamibot.cn/(已备案,适合小程序等需域名备案的场景) - 协议:HTTPS
- 认证方式:个人访问令牌(Personal Access Token),放在 HTTP Header 里
获取个人访问令牌
- 登录 Hamibot 控制台
- 进入「账号设置 → 令牌管理」
- 点击「生成新令牌」,复制保存(只显示一次)
- 令牌前缀是
hmp_
令牌放哪
Authorization: hmp_xxxxxxxxxxxxxxxx
每次 API 请求都要在 Header 里带上。示例(curl):
curl -H "Authorization: hmp_your_token" https://api.hamibot.com/
速率限制与配额
平台有请求频率限制,返回的 HTTP Header 里会带:
- 当前窗口剩余请求数
- 窗口重置时间
免费用户配额(可在控制台查看):
| 类型 | 免费额度 |
|---|---|
| 配对额度 | 1 |
| 定时任务 | 1 |
| API 请求 | 100 |
订阅后配额会增加。
常用 API 列表
| 能力 | 说明 |
|---|---|
| 设备管理 | 查询设备列表、查看在线状态 |
| 脚本执行 | 下发脚本到指定设备运行、停止运行 |
| 定时任务 | 创建 / 修改 / 删除定时任务 |
| 远程执行 | 直接在设备上执行一段 JavaScript 代码 |
| 日志获取 | 拉取设备上脚本的运行日志 |
远程执行代码(最灵活的接口)
这个接口可以绕过脚本市场,直接在指定设备上执行一段 JS 代码。参数:
code:要执行的 JavaScript 代码字符串devices:目标设备 ID 列表(可以多个)vars:可选,代码里能访问的变量字典
典型场景
批量给多台设备下发同一个指令
比如让 10 台设备同时打开某个 APP:调用远程执行接口,devices 里放 10 台设备的 ID,code 里写 app.launch('com.example.app')。
接入自己的监控系统
定时轮询 API 检查设备在线状态,离线时告警。
自建调度平台
不想用 Hamibot 自带的定时任务逻辑,用自己的 cron 或任务编排系统,到期时调 API 下发脚本。
安全提示
- 令牌等价于账号密码,不要泄露
- 建议定期轮换令牌
- 如果令牌泄露,立即在控制台撤销并生成新的