API SIEM

Updated: July 06, 2026

SIEM API cung cấp các sự kiện kiểm tra (audit) của 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 dùng API này để nạp nhật ký kiểm tra của Altium 365 vào hệ thống Security Information and Event Management (SIEM) của bạn hoặc bất kỳ công cụ tuân thủ bên ngoài nào.

Enterprise license required. Tùy chọn Audit Export chỉ xuất hiện trong phần cài đặt Workspace Admin khi giấy phép cấp Enterprise đang được kích hoạt.

Tìm Endpoint và Thông tin xác thực của bạn

Mỗi Workspace có URL endpoint audit và thông tin xác thực riêng. Để tìm chúng:

Đi tới 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 Secret Key từ trang này bất kỳ lúc nào. Khi tạo lại khóa, khóa trước đó sẽ bị vô hiệu hóa ngay lập tức.

Xác thực

Mọi yêu cầu đều cần hai header tùy chỉnh:

Header	Value
`ClientId`	Workspace Client ID của bạn
`ClientSecret`	Workspace Secret Key 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ả. 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ụ 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	Kiểu	Mô tả
`TotalCount`	integer	Tổng số sự kiện khả dụng trên tất cả các trang
`Events`	array	Các sự kiện trên trang hiện tại

Các trường sự kiện

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

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

Trường	Kiểu	Mô tả
`dvchost`	string	Tên miền đủ điều kiện của Workspace
`msg`	string	Mô tả sự kiện dễ đọc với con người
`rt`	string	Dấu thời gian của sự kiện (ISO 8601)
`dtz`	string	Múi giờ (ví dụ: `"UTC+00:00"`)
`suser`	string	Tên người dùng liên quan đến sự kiện
`act`	string	Hành động được thực hiện (ví dụ: `"login"`, `"create"`, `"delete"`)
`externalId`	string	ID thực thể khởi tạo
`cat`	string	Danh mục 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 cần lấy bao nhiêu trang. Tăng Offset theo giá trị Limit của bạn ở mỗi yêu cầu tiếp theo cho đến khi lấy được toàn bộ sự kiện.

Page 1: Offset=0,   Limit=500   → events 1–500
Page 2: Offset=500, Limit=500   → events 501–1000
...

Mã trạng thái HTTP

Mã	Ý nghĩa
`200 OK`	Các 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 xác thực không hợp lệ hoặc giấy phép Enterprise chưa được kích hoạt

Đọc thêm

Audit Export trong Altium 365 – thiết lập và cấu hình cho 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.