研几科技

Appearance

设备绑定与解绑 ​

设备只能通过 bind 接口添加到组织，不支持直接创建；通过 unbind 接口从组织中删除。

重要说明

  • unbind接口只是从组织中删除设备，即设备和组织解绑，并不会从数据库中删除设备
  • 解绑的设备，可以被其他组织再次绑定

绑定设备 ​

http
POST /api/v2/devices/bind/

接口说明

将设备绑定到当前组织。

请求参数 ​

参数类型必填说明
device_idstring是设备ID
safe_codestring是设备安全码

请求示例 ​

请求数据

json
{
    "device_id": "device_id",
    "safe_code": "safe_code"
}

响应 ​

返回数据 (200 OK)

返回数据请查看 获取设备列表。

代码示例 ​

Python
python
def bind_device(device_id, safe_code):
    """绑定设备
    
    Args:
        device_id: 设备ID
        safe_code: 设备安全码
    """
    headers = {
        "Authorization": f"Bearer {ACCESS_TOKEN}",
        "Content-Type": "application/json"
    }
    
    data = {
        "device_id": device_id,
        "safe_code": safe_code
    }
    
    url = f"{API_BASE}/devices/bind/"
    response = requests.post(url, headers=headers, json=data)
    return response.json()

# 使用示例
device_id = "device_1"
safe_code = "1234567890"
result = bind_device(device_id, safe_code)
print(f"绑定结果: {result}")
cURL
bash
curl -X POST "https://ums.holdingbyte.com/api/v2/devices/bind/" \
     -H "Authorization: Bearer your_access_token" \
     -H "Content-Type: application/json" \
     -d '{"device_id": "device_1", "safe_code": "1234567890"}'

错误响应 ​

错误响应

设备绑定API可能返回的错误响应遵循统一的格式。有关详细的错误码和处理方法，请参阅API错误响应文档。

解绑设备 ​

http
POST /api/v2/devices/{device_id}/unbind/

接口说明

解除设备与当前组织的绑定关系。

响应 ​

返回数据 (204 No Content)

成功解绑返回 204 状态码，无响应内容。

代码示例 ​

Python
python
def unbind_device(device_id):
    """解绑设备
    
    Args:
        device_id: 设备ID
    """
    headers = {
        "Authorization": f"Bearer {ACCESS_TOKEN}",
        "Content-Type": "application/json"
    }
    
    url = f"{API_BASE}/devices/{device_id}/unbind/"
    response = requests.post(url, headers=headers)
    return response.status_code == 204

# 使用示例
device_id = "device_1"
success = unbind_device(device_id)
print(f"解绑{'成功' if success else '失败'}")
cURL
bash
curl -X POST "https://ums.holdingbyte.com/api/v2/devices/device_1/unbind/" \
     -H "Authorization: Bearer your_access_token"

错误响应 ​

错误响应

设备解绑API可能返回的错误响应遵循统一的格式。有关详细的错误码和处理方法，请参阅API错误响应文档。