Tài liệu API thiết bị điện thoại đám mây LAN - Tài liệu

Nguồn gốc: Tài liệu trợ giúp Yuque

Tổng quan

Hộp mây Nest cung cấp API HTTP cho mạng cục bộ, cho phép quản lý và kiểm soát thiết bị và các phiên bản điện thoại đám mây thông qua mã, phù hợp cho:

Kịch bản tự động hóa vận hành
Tích hợp với hệ thống của bên thứ ba
Đặt lịch cho các tác vụ hàng loạt

Phiên bản API: V1_0
Địa chỉ cơ sở giao diện: http://<địa_chỉ_IP_thiết_bị>:3001/api/1_0

Xây dựng yêu cầu

const HTTP = require('http');

const base_url = 'http://x.x.x.x:3001/api/1_0';

// Ví dụ: Lấy thông tin thiết bị
const api = base_url + '/systeminfo';
HTTP.get(api, function(err, res) {
  // Xử lý phản hồi
});

Thay x.x.x.x bằng địa chỉ IP thực tế của thiết bị hộp mây trong mạng cục bộ.

Danh sách giao diện

GET /systeminfo

Chức năng: Lấy thông tin cơ bản về thiết bị
Có cần xác thực không: Không

Ví dụ về phản hồi:

{
  "code": 0,
  "data": {
    "device_id": "nestbox-001",
    "model": "NestBox Pro",
    "android_version": "12",
    "cpu_usage": 23.5,
    "memory_total": 8192,
    "memory_used": 3421,
    "storage_total": 128000,
    "storage_used": 45320
  }
}

GET /get_container_list

Chức năng: Lấy danh sách tất cả các phiên bản điện thoại đám mây hiện tại
Có cần xác thực không: Không

Ví dụ về phản hồi:

{
  "code": 0,
  "data": [
    {
      "id": "container-001",
      "name": "Điện thoại đám mây 01",
      "status": "running",
      "ip": "172.16.0.101",
      "port": 5555,
      "created_at": "2025-04-01T10:00:00Z"
    }
  ]
}

POST /start_container

Chức năng: Khởi chạy phiên bản điện thoại đám mây được chỉ định
Có cần xác thực không: Có (cần truyền token)

Tham số yêu cầu:

Tham số	Kiểu	Bắt buộc	Mô tả
`container_id`	string	Có	ID phiên bản
`token`	string	Có	Token xác thực quản trị viên

Ví dụ về yêu cầu:

const options = {
  hostname: 'x.x.x.x',
  port: 3001,
  path: '/api/1_0/start_container',
  method: 'POST',
  headers: { 'Content-Type': 'application/json' }
};

const body = JSON.stringify({
  container_id: 'container-001',
  token: 'your-admin-token'
});

POST /stop_container

Chức năng: Dừng phiên bản điện thoại đám mây được chỉ định
Tham số: Giống như /start_container

GET /container_info

Chức năng: Lấy thông tin chi tiết về một phiên bản
Tham số:

Tham số	Kiểu	Bắt buộc	Mô tả
`container_id`	string	Có	ID phiên bản

Giải thích mã lỗi

code	Ý nghĩa
`0`	Thành công
`401`	Chưa được xác thực (thiếu token)
`404`	Phiên bản không tồn tại
`500`	Lỗi nội bộ máy chủ