API của Altium 365
API Altium 365 là một 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ộ phạm vi của nền tảng.
Cách API được tổ chức
API được cấu trúc xoay quanh các miền chức năng của nền tảng, được gọi là bounded contexts. Mỗi bounded context bao quát 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 chức năng 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 quát |
Design |
Dự án PCB, sơ đồ nguyên lý, biến thể, bản phát hành, gói sản xuất |
Library |
Linh kiện, ký hiệu, footprint, part, yêu cầu part, datasheet |
Procurement |
Danh mục vật tư, mục BOM, part thay thế tương đương và part thay thế |
Platform |
Người dùng, Workspace, tổ chức, định nghĩa vòng đời, quy tắc đặt tên revision |
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 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, 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 thông 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 đó, trình duyệt schema Voyager tích hợp sẵn là một cách hữu ích để khám phá toàn bộ đồ thị kiểu.
Khám phá Schema
API Altium 365 có khả năng tự mô tả. 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 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ộ schema, hữu ích để hiểu mối quan hệ giữa các kiểu:
https://{workspace-domain}/api/voyager/
Điểm cuối
Điểm cuối Workspace
Đối với hầu hết các tích hợp, hãy sử dụng điểm cuối Workspace. Điểm cuối 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 |
|
|
Điểm cuối theo khu vực
Hãy sử dụng điểm cuối 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à 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 |
|
|
Bờ Tây Hoa Kỳ |
|
|
Bờ Đô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 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 Mục Này
Bản địa hóa bằng AI