Giao diện lập trình ứng dụng (API) SIEM

Updated: May 21, 2026

Giao diện API SIEM cung cấp các sự kiện kiểm tra Workspace dưới dạng nguồn cấp dữ liệu JSON được phân trang, tương thích với tiêu chuẩn Common Event Format (CEF). Hãy sử dụng tính năng này để nhập nhật ký kiểm tra Altium 365 vào hệ thống Quản lý Thông tin và Sự kiện An ninh (SIEM) hoặc bất kỳ công cụ tuân thủ bên ngoài nào

Enterprise license required. Tùy chọn Xuất nhật ký kiểm tra chỉ xuất hiện trong cài đặt Quản trị Workspace khi giấy phép cấp Doanh nghiệp đang hoạt động.

Tìm điểm cuối và thông tin đăng nhập

Mỗi Workspace có URL điểm cuối kiểm tra và thông tin đăng nhập riêng. Để tìm chúng

Truy cập Admin → Settings → Audit Export trong Workspace của bạn.
Sao chép Endpoint URL, Client ID, và Secret Key.

Bạn có thể tạo lại hoặc thu hồi Khóa bí mật từ trang này bất cứ lúc nào. Việc tạo lại khóa sẽ ngay lập tức làm vô hiệu hóa khóa trước đó

Xác thực

Mỗi yêu cầu đều yêu cầu hai tiêu đề tùy chỉnh

Header	Value
`ClientId`	ID Khách hàng của Không gian làm việc của bạn
`ClientSecret`	Khóa bí mật Workspace của bạn

Lấy sự kiện

GET {your-audit-endpoint}?Offset=0&Limit=500
ClientId: {your-client-id}
ClientSecret: {your-secret-key}

Tham số truy vấn

Tham số	Bắt buộc	Mô tả
`Offset`	Không	Vị trí bắt đầu trong tập kết quả. Giá trị mặc định: `0`
`Limit`	Không	Số lượng sự kiện tối đa được trả về. Không được vượt quá giới hạn tối đa của API; nếu vượt quá sẽ trả về `400`.

Ví dụ về Curl

curl -G '{your-audit-endpoint}' \
  -H 'ClientId: {your-client-id}' \
  -H 'ClientSecret: {your-secret-key}' \
  --data-urlencode 'Offset=0' \
  --data-urlencode 'Limit=500'

Định dạng phản hồi

{
  "TotalCount": 2,
  "Events": [
    {
      "CefVersion": "1",
      "DeviceVendor": "Altium",
      "DeviceProduct": "365 Platform",
      "DeviceVersion": "Cloud",
      "DeviceEventClassId": "",
      "Name": "User Login",
      "Extension": {
        "dvchost": "host.domain.com",
        "msg": "User successful login",
        "rt": "2024-01-10T14:30:00Z",
        "dtz": "UTC+00:00",
        "suser": "sampleuser",
        "act": "login",
        "externalId": "45678",
        "cat": "authentication"
      }
    }
  ]
}

Các trường cấp cao nhất

Trường	Loại	Mô tả
`TotalCount`	số nguyên	Tổng số sự kiện có sẵn trên tất cả các trang
`Events`	mảng	Sự kiện trên trang hiện tại

Trường sự kiện

Trường	Loại	Mô tả
`CefVersion`	chuỗi	Phiên bản CEF
`DeviceVendor`	chuỗi	Luôn luôn `"Altium"`
`DeviceProduct`	chuỗi	Luôn luôn `"365 Platform"`
`DeviceVersion`	chuỗi	Luôn luôn `"Cloud"`
`DeviceEventClassId`	chuỗi	Mã định danh lớp sự kiện
`Name`	chuỗi	Tên sự kiện dễ đọc (ví dụ: `"User Login"`)
`Extension`	đối tượng	Dữ liệu chi tiết của sự kiện – xem bên dưới

Các trường mở rộng

Trường	Loại	Mô tả
`dvchost`	chuỗi	Tên miền đầy đủ của Workspace
`msg`	chuỗi	Mô tả sự kiện dễ hiểu
`rt`	chuỗi	Dấu thời gian sự kiện (ISO 8601)
`dtz`	chuỗi	Múi giờ (ví dụ: `"UTC+00:00"`)
`suser`	chuỗi	Tên người dùng liên quan đến sự kiện
`act`	chuỗi	Hành động đã thực hiện (ví dụ: `"login"`, `"create"`, `"delete"`)
`externalId`	chuỗi	ID thực thể khởi tạo
`cat`	chuỗi	Loại sự kiện (ví dụ: `"authentication"`, `"design"`)

Phân trang

Sử dụng TotalCount từ phản hồi đầu tiên để xác định số trang cần lấy. Tăng Offset theo Limit trong mỗi yêu cầu tiếp theo cho đến khi tất cả các sự kiện được lấy về

Trang 1: Offset=0,   Limit=500   → sự kiện 1–500
Trang 2: Offset=500, Limit=500   → sự kiện 501–1000
...

Mã trạng thái HTTP

Mã	Ý nghĩa
`200 OK`	Sự kiện được trả về thành công
`400 Bad Request`	`Limit` vượt quá giới hạn tối đa của API
`401 Unauthorized`	Thông tin đăng nhập không hợp lệ hoặc giấy phép Enterprise chưa được kích hoạt

Đọc thêm

Xuất bản kiểm toán trong Altium 365 – Thiết lập và cấu hình quản trị viên Workspace

Phiên bản thân thiện với máy in

Bản địa hóa bằng AI

Nếu bạn phát hiện vấn đề, hãy chọn văn bản/hình ảnh và nhấnCtrl + Enterđể gửi phản hồi cho chúng tôi.