API Altium 365
Altium 365 API là một API GraphQL cho phép truy cập dữ liệu Workspace trên Altium 365 của bạn thông qua lập trình. API hỗ trợ cả thao tác đọc và ghi trên toàn bộ nền tảng.
Cách tổ chức API
API được cấu trúc theo các miền nghiệp vụ của nền tảng, được gọi là bounded contexts. Mỗi ngữ cảnh giới hạn bao quát một lĩnh vực cụ thể của nền tảng – các thực thể, thao tác và quy tắc nghiệp vụ của lĩnh vực đó. Tên kiểu và truy vấn GraphQL tuân theo các quy ước đặt tên phản ánh miền nghiệp vụ mà chúng thuộc về, giúp bạn dễ dàng tra cứu lược đồ hơn khi đã quen với cấu trúc này.
Các ngữ cảnh giới hạn chính
Ngữ cảnh giới hạn |
Phạm vi bao quát |
Design |
Dự án PCB, sơ đồ nguyên lý, biến thể, bản phát hành, gói dữ liệu sản xuất |
Library |
Linh kiện, ký hiệu, footprint, mã linh kiện, yêu cầu linh kiện, bảng dữ liệu |
Procurement |
Danh mục vật tư, mục BOM, linh kiện thay thế và linh kiện tương đương |
Platform |
Người dùng, Workspace, tổ chức, định nghĩa vòng đời, cách đặt tên bản sửa đổi |
Collaboration |
Bình luận, luồng bình luận, tác vụ |
Customization |
Quy trình làm việc, tập lệnh, lượt thực thi tập lệnh |
Các ngữ cảnh giới hạn bổ sung bao quát những khả năng chuyên biệt hơn – mô hình hóa thiết bị, cập nhật firmware qua mạng không dây, quản lý yêu cầu, phần mềm nhúng và thiết kế hệ thống. Bạn có thể truy cập các ngữ cảnh này thông qua cùng một API và chúng tuân theo cùng các quy ước.
Mỗi ngữ cảnh giới hạn sẽ có một phần tài liệu riêng khi phạm vi tài liệu được mở rộng. Trong thời gian chờ đợi, trình duyệt lược đồ Voyager tích hợp sẵn là một công cụ hữu ích để khám phá toàn bộ đồ thị kiểu.
Điểm cuối
Điểm cuối theo khu vực
Sử dụng điểm cuối theo khu vực khi không có Workspace nào trong phạm vi thao tác – ví dụ, để liệt kê tất cả Workspace mà một người dùng có quyền truy cập – hoặc khi làm việc với dữ liệu toàn cục như người dùng và tổ chức.
Khu vực |
GraphQL |
Dịch vụ tệp |
Voyager (khám phá lược đồ) |
Châu Âu |
|
|
https://eur.365.altium.com/api/voyager |
Miền Tây Hoa Kỳ |
|
|
https://usw.365.altium.com/api/voyager |
Miền Đông Hoa Kỳ |
|
|
https://use.365.altium.com/api/voyager |
Châu Á – Thái Bình Dương |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Điểm cuối Workspace
Điểm cuối Workspace là điểm khởi đầu được khuyến nghị để tương tác với các tài nguyên dành riêng cho Workspace. Các điểm cuối API sử dụng cùng tên miền Workspace và có thể được xác định thông qua lập trình – xem ví dụ Liệt kê Workspace.
GraphQL |
Dịch vụ tệp |
Voyager (khám phá lược đồ) |
|
|
https://{workspace-domain}/api/voyager |
Khám phá lược đồ
Altium 365 API có khả năng tự mô tả. Hai công cụ tích hợp sẵn có thể được truy cập trực tiếp từ URL Workspace của bạn:
-
Nitro – một IDE GraphQL trên trình duyệt để viết và chạy truy vấn theo cách tương tác:
https://{workspace-domain}/api/graphql/ -
Voyager – một đồ thị trực quan của toàn bộ lược đồ, hữu ích để hiểu các mối quan hệ giữa các kiểu:
https://{workspace-domain}/api/voyager/
Xác thực
Tất cả yêu cầu phải bao gồm một token truy cập hợp lệ:
Authorization: Bearer {access-token}
Xem Sử dụng token truy cập để biết chi tiết.
Trong phần này
Bản địa hóa bằng AI