Skip to content

设备管理

1. 准备

基础域名https://api.rokid.com

准备

  • 确保已经获取到了有效的API密钥(API_KEY),用于身份验证。
  • 确保设备已经在灵眸平台上设备管理https://x-inspection.rokid.com/main/devices )完成注册。

2. 功能介绍

设备管理模块提供了设备的注册、查询、删除等功能,帮助开发者获取眼镜的设备信息和状态。

2.1 查询设备列表

接口地址:https://api.rokid.com/ar/core/openapi/device/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述: 查询设备列表

请求参数:

参数名称参数说明是否必须数据类型
deviceSn设备SN号,支持模糊查询falsestring
deviceName设备名称,支持模糊查询falsestring

输出结果:

参数名称参数说明是否必须数据类型
deviceSn设备SN号,支持模糊查询truestring
deviceName设备名称,支持模糊查询truestring
deviceType设备类型:
GLASS3 企业版GLASS3_LITE 暴龙版
GLASS_OTHER 其他
truestring
status在线状态:
online 在线
offline 离线
truestring

请求示例:

json
curl -X POST https://api.rokid.com/ar/core/openapi/device/list \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "deviceSn":"设备SN号",
    "deviceName":"设备名称"
}'

响应示例:

json
{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "deviceName": "glass3_001715",
      "deviceSn": "1901092524001715",
      "deviceType": "GLASS3",
      "status": "offline"
    }
  ],
  "success": true
}

2.2 查询设备详情

接口地址:https://api.rokid.com/ar/core/openapi/device/detail?deviceSn={$deviceSn}

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述: 查询设备详情

请求参数:

参数名称参数说明是否必须数据类型
deviceSn设备SN号truestring

输出结果:

参数名称参数说明是否必须数据类型
deviceSn设备SN号,支持模糊查询truestring
deviceName设备名称,支持模糊查询truestring
deviceType设备类型:
GLASS3 企业版GLASS3_LITE 暴龙版
GLASS_OTHER 其他
truestring
status在线状态:
online 在线
offline 离线
truestring

请求示例:

json
curl -X GET https://api.rokid.com/ar/core/openapi/device/detail?deviceSn=1901092524001715 \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"

响应示例:

json
{
  "code": 0,
  "message": "OK",
  "data": {
    "deviceName": "glass3_001715",
    "deviceSn": "1901092524001715",
    "deviceType": "GLASS3",
    "status": "offline"
  },
  "success": true
}

2.1 查询设备实时数据

接口地址:https://api.rokid.com/ar/core/openapi/device/realData?deviceSn={$deviceSn}

请求方式:GET

请求数据类型:application/json

响应数据类型:*/*

接口描述: 查询设备实时数据

请求参数:

参数名称参数说明是否必须数据类型
deviceSn设备SN号truestring

输出结果:

参数名称参数说明是否必须数据类型
powerValue电量百分比trueint
currentUserId当前使用用户uidtruestring

请求示例:

json
curl -X GET https://api.rokid.com/ar/core/openapi/device/detail?deviceSn=1901092524001715 \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"

响应示例:

json
{
  "code": 0,
  "message": "OK",
  "data": {
    "powerValue": 100,
    "currentUserId": "E0BB5354E9F54BC6A032E8B709CC7B2E"
  },
  "success": true
}