Hướng dẫn bắt đầu nhanh với API Altium 365

Altium 365 API cho phép bạn truy cập dữ liệu trong Workspace bằng lập trình – bao gồm dự án, BOM, linh kiện, ký hiệu, footprint và nhiều dữ liệu khác. Đây là một API GraphQL, nghĩa là bạn có thể truy vấn chính xác dữ liệu mình cần chỉ trong một yêu cầu.

Hướng dẫn này giúp bạn bắt đầu từ con số không và thực hiện lệnh gọi API đầu tiên chỉ trong vài phút.

Điều kiện tiên quyết

• Một Workspace Altium 365

• Một tài khoản quản trị viên Workspace

• Một tài khoản trên Altium Developer Center – cổng thông tin tự phục vụ của Altium dành cho nhà phát triển, nơi bạn có thể đăng ký các chương trình để truy cập Altium 365 API, Altium Designer SDK, Embeddable Viewer và các sản phẩm khác dành cho nhà phát triển

Bước 1: Tạo token

Để cấp quyền cho các yêu cầu API, bạn cần có token truy cập. Token được tạo trong Workspace của bạn tại Admin → Developer.

Khi tạo token, bạn có thể chọn một trong hai tùy chọn sau.

Tùy chọn A: Token truy cập dài hạn

Đây là cách đơn giản nhất để bắt đầu. Bạn nhận được một token truy cập duy nhất với thời hạn có thể cấu hình (tối đa 1 năm). Hãy sử dụng token này trực tiếp trong các yêu cầu API.

Phù hợp cho: khám phá nhanh, tập lệnh và các tích hợp ưu tiên sự đơn giản.

Xem Sử dụng token truy cập để biết chi tiết.

Tùy chọn B: Token làm mới (Khuyến nghị cho môi trường vận hành thực tế)

Đây là phương thức bảo mật hơn. Bạn nhận được một refresh token cùng với một client ID và client secret. Token làm mới được trao đổi bằng lập trình để lấy token truy cập ngắn hạn, sau đó token truy cập này được dùng trong các yêu cầu API. Bản thân token làm mới có thời hạn có thể cấu hình (tối đa 1 năm).

Phù hợp cho: tích hợp tự động, dịch vụ chạy nền và mọi ứng dụng hoạt động 24/7 trong môi trường vận hành thực tế.

Xem Sử dụng token làm mới để biết quy trình trao đổi.

Bước 2: Gửi yêu cầu API đầu tiên

Cách nhanh nhất để khám phá Altium 365 API là thông qua IDE tích hợp trên trình duyệt (sử dụng Nitro). Truy cập:

https://{workspace-subdomain}.365.altium.com/api/graphql/

Thay {workspace-subdomain} bằng tên miền phụ Workspace thực tế của bạn, ví dụ: https://my-company.365.altium.com/api/graphql.

Cấp quyền cho yêu cầu

Tất cả yêu cầu API đều cần có token truy cập được truyền trong tiêu đề HTTP Authorization với lược đồ Bearer:

Authorization: Bearer {access-token}

Chạy truy vấn đầu tiên

Một truy vấn phù hợp để bắt đầu là liệt kê các dự án trong Workspace:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Dán truy vấn vào IDE, nhấp vào Run và bạn sẽ thấy các dự án trong Workspace xuất hiện trong phản hồi.

Bạn cũng có thể khám phá toàn bộ lược đồ API một cách trực quan tại:

https://{workspace-subdomain}.365.altium.com/api/voyager

Các bước tiếp theo

• Khám phá tổ chức GitHub AltiumDeveloper để tìm các ứng dụng minh họa và truy vấn mẫu

• Xem Sử dụng token truy cập để biết cách sử dụng token trong mã và tập lệnh

• Xem Sử dụng token làm mới để triển khai các tích hợp tự động