Altium 365 API
Altium 365 API là API GraphQL cung cấp quyền truy cập theo chương trình vào dữ liệu Workspace Altium 365 của bạn. API này 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 xoay quanh các miền của nền tảng, được gọi là bounded contexts. Mỗi bounded context bao phủ một khu 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 khu 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 mà chúng thuộc về, giúp bạn dễ dàng điều hướng schema hơn khi đã quen với cấu trúc này.
Các Bounded Context chính
Bounded Context |
Nội dung bao phủ |
Design |
Các dự án PCB, sơ đồ nguyên lý, biến thể, bản phát hành, gói sản xuất |
Library |
Các component, symbol, footprint, part, yêu cầu part, datasheet |
Procurement |
Danh mục vật tư, các mục BOM, part thay thế và part tương đương |
Platform |
Người dùng, Workspace, tổ chức, định nghĩa vòng đời, quy tắc đặt tên phiên bản sửa đổi |
Collaboration |
Bình luận, chuỗi bình luận, tác vụ |
Customization |
Workflow, script, các lần thực thi script |
Các bounded context bổ sung bao phủ những khả năng chuyên biệt hơn – mô hình hóa thiết bị, cập nhật firmware over-the-air, quản lý yêu cầu, phần mềm nhúng và thiết kế hệ thống. Tất cả đều có thể truy cập qua cùng một API và tuân theo cùng các quy ước.
Mỗi bounded context sẽ có phần tài liệu riêng khi phạm vi tài liệu được mở rộng. Trong lúc này, trình duyệt schema Voyager tích hợp sẵn là một cách tốt để khám phá toàn bộ đồ thị kiểu.
Khám phá Schema
Altium 365 API có khả năng tự mô tả tài liệu. Có hai công cụ tích hợp sẵn, khả dụng trực tiếp từ URL Workspace của bạn:
-
Nitro – một GraphQL IDE trên trình duyệt để viết và chạy truy vấn tương tác:
https://{workspace-domain}/api/graphql/ -
Voyager – một đồ thị trực quan của toàn bộ schema, hữu ích để hiểu mối quan hệ giữa các kiểu:
https://{workspace-domain}/api/voyager/
Endpoint
Endpoint Workspace
Đối với hầu hết các tích hợp, hãy sử dụng endpoint Workspace. Endpoint này nhắm đến một Workspace cụ thể và là điểm khởi đầu được khuyến nghị:
|
GraphQL |
Dịch vụ Tệp |
Workspace |
|
|
Endpoint theo khu vực
Hãy sử dụng endpoint theo khu vực khi bạn không có Workspace trong phạm vi làm việ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 |
Châu Âu |
|
|
Miền Tây Hoa Kỳ |
|
|
Miền Đông Hoa Kỳ |
|
|
Châu Á - Thái Bình Dương |
|
|
Gov Cloud |
|
|
Xác thực
Tất cả các yêu cầu phải bao gồm một access token hợp lệ:
Authorization: Bearer {access-token}
Xem Sử dụng Access Token để biết chi tiết.
Trong phần này
Bản địa hóa bằng AI