Tài liệu dành cho nhà phát triển

EdgeOS API Reference

Bộ REST API đầy đủ cho quản lý vòng đời instance AI, cấu hình phân tích an ninh, luồng sự kiện thời gian thực và điều khiển camera ONVIF.

328 Endpoint

3 Nhóm API

REST Kiến trúc

SSE Sự kiện thời gian thực

Yêu cầu quyền truy cập Cổng nhà phát triển

URL GỐC http://<device-ip>:8080 Không yêu cầu xác thực khi truy cập trong mạng nội bộ

Kiến trúc API

Ba nhóm chức năng chuyên biệt

EdgeOS API được tổ chức thành 3 nhóm theo chức năng. Mỗi nhóm phục vụ một kiểu tích hợp riêng biệt.

⚙️

CORE API

Quản lý vòng đời instance, vận hành hệ thống, suy luận AI, cấu hình và quản lý tệp.

250+ endpoint

CoreLogsConfigInstances +9

🛡️

SECURT API

Cấu hình phân tích an ninh: vùng phát hiện thông minh, hàng rào ảo và luật phân tích hành vi.

65+ endpoint

SecuRT InstanceLines SecuRTArea SecuRT

📡

ONVIF API

Dò tìm và quản lý camera ONVIF: quét mạng, lấy luồng và cấu hình thông tin xác thực camera.

4+ endpoint

ONVIF

Tham chiếu endpoint

⚙️ CORE API Endpoint

Core 8 endpoint

GET /v1/core/health Kiểm tra trạng thái

GET /v1/core/version Lấy phiên bản API

GET /v1/core/system/info Lấy thông tin hệ thống

GET /v1/core/system/status Lấy trạng thái hệ thống

GET /v1/core/metrics Lấy chỉ số hệ thống

POST /v1/core/system/shutdown Tắt hệ thống

GET /v1/core/license/info Lấy thông tin giấy phép

POST /v1/core/license/check Kiểm tra tính hợp lệ giấy phép

Logs 3 endpoint

GET /v1/core/log Lấy danh mục log

GET /v1/core/log/{category} Lấy log theo danh mục

GET /v1/core/log/{category}/{date} Lấy log theo danh mục và ngày

Config 6 endpoint

GET /v1/core/config Lấy toàn bộ cấu hình

POST /v1/core/config Tạo mục cấu hình

GET /v1/core/config/{path} Lấy cấu hình theo đường dẫn

PUT /v1/core/config/{path} Cập nhật cấu hình

DELETE /v1/core/config/{path} Xóa mục cấu hình

POST /v1/core/config/reset Đặt lại cấu hình mặc định

Instances 25 endpoint

GET /v1/core/instance Liệt kê tất cả instance

POST /v1/core/instance Tạo instance mới

POST /v1/core/instance/quick Tạo nhanh instance

GET /v1/core/instance/{instanceId} Lấy chi tiết instance

PUT /v1/core/instance/{instanceId} Cập nhật instance

DELETE /v1/core/instance/{instanceId} Xóa instance

POST /v1/core/instance/{instanceId}/start Khởi động instance

POST /v1/core/instance/{instanceId}/stop Dừng instance

POST /v1/core/instance/{instanceId}/restart Khởi động lại instance

GET /v1/core/instance/{instanceId}/state Lấy trạng thái instance

GET /v1/core/instance/{instanceId}/statistics Lấy thống kê instance

GET /v1/core/instance/{instanceId}/consume_events Nhận sự kiện (SSE stream)

POST /v1/core/instance/{instanceId}/frame Đẩy frame vào instance

POST /v1/core/instance/{instanceId}/push_compressed Đẩy frame nén

GET /v1/core/instance/{instanceId}/input Lấy cấu hình đầu vào

PUT /v1/core/instance/{instanceId}/input Cập nhật nguồn đầu vào

GET /v1/core/instance/{instanceId}/output Lấy cấu hình đầu ra

PUT /v1/core/instance/{instanceId}/output Cập nhật thiết lập đầu ra

GET /v1/core/instance/{instanceId}/output/hls Lấy URL luồng đầu ra HLS

GET /v1/core/instance/{instanceId}/preview Lấy khung hình xem trước instance

GET /v1/core/instance/{instanceId}/classes Lấy danh sách lớp phát hiện

POST /v1/core/instance/batch/start Khởi động hàng loạt instance

POST /v1/core/instance/batch/stop Dừng hàng loạt instance

POST /v1/core/instance/batch/restart Khởi động lại hàng loạt instance

GET /v1/core/instance/status/summary Lấy tóm tắt trạng thái tổng thể

AI 4 endpoint

POST /v1/core/ai/process Xử lý một ảnh hoặc frame

POST /v1/core/ai/batch Xử lý hàng loạt ảnh

GET /v1/core/ai/status Lấy trạng thái xử lý AI

GET /v1/core/ai/metrics Lấy chỉ số xử lý AI

Solutions 6 endpoint

GET /v1/core/solution Liệt kê tất cả solution

POST /v1/core/solution Tạo solution

GET /v1/core/solution/{solutionId} Lấy chi tiết solution

PUT /v1/core/solution/{solutionId} Cập nhật solution

DELETE /v1/core/solution/{solutionId} Xóa solution

GET /v1/core/solution/defaults Lấy cấu hình mặc định solution

Groups 5 endpoint

GET /v1/core/groups Liệt kê tất cả group

POST /v1/core/groups Tạo group

GET /v1/core/groups/{groupId} Lấy chi tiết group

PUT /v1/core/groups/{groupId} Cập nhật group

DELETE /v1/core/groups/{groupId} Xóa group

Models 3 endpoint

GET /v1/core/model/list Liệt kê model khả dụng

POST /v1/core/model/upload Tải lên file model

DELETE /v1/core/model/{modelName} Xóa model

Video 3 endpoint

GET /v1/core/video/list Liệt kê file video

POST /v1/core/video/upload Tải lên file video

DELETE /v1/core/video/{videoName} Xóa file video

Node 5 endpoint

GET /v1/core/node Liệt kê node pool

POST /v1/core/node Tạo node

GET /v1/core/node/stats Lấy thống kê node

GET /v1/core/node/preconfigured Lấy node cấu hình sẵn

GET /v1/core/node/template Liệt kê mẫu node

Area Core 4 endpoint

POST /v1/core/instance/{instanceId}/jams Tạo vùng phát hiện kẹt xe

GET /v1/core/instance/{instanceId}/jams Lấy tất cả vùng kẹt xe

POST /v1/core/instance/{instanceId}/stops Tạo vùng phát hiện dừng xe

GET /v1/core/instance/{instanceId}/stops Lấy tất cả vùng dừng xe

Ví dụ mã nguồn

Bắt đầu tích hợp trong vài phút

Các mẫu tích hợp phổ biến với ví dụ sẵn sàng chạy.

Kiểm tra trạng thái

Xác minh API server đang chạy và phản hồi bình thường.

curl http://localhost:8080/v1/core/health

Khái niệm chính

Thành phần lõi

🔷

Instance

Đơn vị xử lý cơ bản. Mỗi instance kết nối với một nguồn video (RTSP, file, frame push) và chạy một solution AI. Instance có thể được tạo, khởi động, dừng và xóa độc lập.

POST /v1/core/instance POST /v1/core/instance/{id}/start

🧩

Solution

Mẫu hành vi AI dựng sẵn (ví dụ ba_crossline, ba_intrusion, face_recognition). Solution xác định model và loại phân tích chạy bên trong một instance.

GET /v1/core/solution GET /v1/core/solution/defaults

📡

Events (SSE)

Sự kiện phát hiện thời gian thực được truyền qua Server-Sent Events. Kết nối vào luồng sự kiện để nhận các phát hiện, băng qua, xâm nhập và đếm ngay khi xảy ra.

GET /v1/core/instance/{id}/consume_events

🗺️

Areas & Lines

Định nghĩa vùng không gian (zone) và line ảo trên khung hình video để kích hoạt các phân tích như xâm nhập, lảng vảng, đếm, băng qua, bám đuôi, chiếm dụng và nhiều hơn nữa.

POST /v1/securt/instance/{id}/area/intrusion POST /v1/securt/instance/{id}/line/counting

🔲

Frame Push

Với kịch bản nhúng hoặc offline, bạn có thể đẩy frame thô trực tiếp vào instance thay vì dùng luồng RTSP. Hỗ trợ định dạng nén và mã hóa.

POST /v1/core/instance/{id}/frame POST /v1/core/instance/{id}/push_compressed

📦

Models & Video

Tải lên và quản lý file model AI tùy chỉnh cùng tài nguyên video trực tiếp qua API. Model được tham chiếu theo tên khi tạo instance hoặc solution.

POST /v1/core/model/upload GET /v1/core/model/list

Tài nguyên

Tài liệu đầy đủ và công cụ

📖

Đặc tả OpenAPI

Đặc tả OpenAPI 3.0.3 đầy đủ với 328 endpoint, schema và response model.

YAML / JSON

🧪

Postman Collection

Bộ sưu tập Postman sẵn sàng import với toàn bộ endpoint đã cấu hình cho kiểm thử.

JSON Collection

🔍

Tài liệu tương tác

Khám phá và kiểm thử trực tiếp mọi endpoint bằng trình Scalar API tích hợp.

Scalar / Swagger UI

🤝

Nhận quyền truy cập

EdgeOS API dành cho đối tác và nhà phát triển. Liên hệ để nhận license thiết bị.

Yêu cầu truy cập