API tích hợp

Tài liệu API Router

API này cung cấp các điểm cuối cho nhà phát triển tương tác và mở rộng chức năng của router. Dưới đây là các điểm cuối chính cùng với ví dụ cURL, định dạng yêu cầu/phản hồi và mô tả chi tiết.

  1. Cập nhật Proxy

  • Điểm cuối: /api/update_proxy

  • Phương thức: POST

  • Mô tả: Cập nhật cấu hình proxy cho các địa chỉ IP được chỉ định.

Yêu cầu

  • Headers: Content-Type: application/json

  • Body: Một đối tượng JSON, trong đó các khóa là địa chỉ IP và các giá trị chứa cấu hình proxy:

    • type: Loại proxy (ví dụ: socks5)

    • server: Địa chỉ máy chủ proxy

    • port: Cổng kết nối

    • username: Tên đằng nhập

    • password: Mật khẩu đăng nhập

    Ví dụ: 

curl --location 'http://192.168.5.1:9000/api/update_proxy' \
--header 'Content-Type: application/json' \
--data '{
    "192.168.4.253": {
        "type": "socks5",
        "server": "179.60.183.234",
        "port": 50101,
        "username": "genrouter",
        "password": "MDoFXVw5s8"
    },
    "192.168.5.104": {
        "type": "socks5",
        "server": "179.60.183.234",
        "port": 50101,
        "username": "genrouter",
        "password": "MDoFXVw5s8"
    }
}'

Phản hồi mẫu

  1. Lấy danh sách thiết bị

  • Điểm cuối: /api/devices

  • Phương thức: GET

  • Mô tả: Lấy danh sách các thiết bị đang kết nối với router cùng với các thông tin chi tiết như địa chỉ IP, MAC, tên máy (hostname), trạng thái kết nối và cấu hình proxy (nếu có). Ví dụ

Phản hồi mẫu

  1. Thông tin hệ thống

  • Điểm cuối: /api/system/info

  • Phương thức: GET

  • Mô tả: Lấy thông tin hệ thống như phiên bản build, commit git, thời gian kiểm tra phiên bản cuối cùng, và trạng thái có cần khởi động lại hay không. Ví dụ

Phản hồi mẫu

  1. Thông tin Router

  • Điểm cuối: /api/router/info

  • Phương thức: GET

  • Mô tả: Lấy cấu hình của router, bao gồm các thiết lập LAN và mạng không dây. Ví dụ

Phản hồi mẫu

  1. Lấy cấu hình hệ thống

  • Điểm cuối: /api/system/config

  • Phương thức: GET

  • Mô tả: Lấy cấu hình hệ thống của router, bao gồm các chế độ như WebRTC và cài đặt proxy toàn cầu. Ví dụ

Phản hồi mẫu

  1. Kiểm tra kết nối mạng

  • Điểm cuối: /api/system/network

  • Phương thức: GET

  • Mô tả: Kiểm tra kết nối mạng của router. Phản hồi với "success": true cho biết router đang kết nối với mạng.

Ví dụ

Phản hồi mẫu

  1. Kiểm tra cập nhật hệ thống

  • Điểm cuối: /api/system/check_for_update

  • Phương thức: GET

  • Mô tả: Kiểm tra xem có bản cập nhật hệ thống mới hay không và cung cấp các thông tin chi tiết như phiên bản build, commit git, ID bản cập nhật, và nhật ký thay đổi (changelog).

Phản hồi mẫu

  1. Tạo mạng wiffi

Điểm cuối /api/router/create_wifi Phương thức: POST Mô tả: Tạo hoặc cấu hình mạng WiFi trên router. Dữ liệu gửi kèm yêu cầu bao gồm thông tin về sóng radio và các SSID sẽ được cấu hình.

Yêu cầu

  • Body: Một đối tượng JSON với khóa data chứa một mảng các đối tượng cấu hình. Mỗi đối tượng bao gồm:

    • id: ID sóng radio (ví dụ: radio0)

    • ssids: Một mảng các đối tượng cấu hình SSID, mỗi đối tượng bao gồm:

      • ssid: Tên mạng WiFi

      • password: Mật khẩu (có thể để null nếu không sử dụng)

      • hidden: Giá trị boolean cho biết SSID có bị ẩn hay không

      • disabled: Giá trị boolean cho biết SSID có bị vô hiệu hóa hay không

      • mac, brand: Các trường bổ sung nếu có

Ví dụ

Phản hồi mẫu

Lưu ý chung

  • Các điểm cuối liên quan đến hệ thống và router (ví dụ: /api/system/info, /api/router/info, /api/system/config, /api/system/network, /api/system/check_for_update, /api/router/create_wifi) có thể cần sử dụng tùy chọn --insecure với cURL nếu hệ thống đang sử dụng chứng chỉ SSL không hợp lệ.

  • Các ví dụ được cung cấp có thể điều chỉnh dựa trên môi trường cụ thể của bạn (địa chỉ IP, cổng, thông tin xác thực, v.v.).

PreviousTính năng phân phối proxyNextSử dụng với giả lập

Last updated