Kết nối một Workspace Altium 365 với các hệ thống bên ngoài

Design data in Altium 365 does not have to stay in Altium 365. The Altium 365 API gives external systems programmatic access to Workspace data – for reading, writing, and reacting to changes.

API Altium 365 cung cấp khả năng truy cập phía máy chủ đến toàn bộ tập hợp thực thể trong Workspace: linh kiện, thiết kế, BOM, siêu dữ liệu dự án, người dùng, quyền hạn và trạng thái vòng đời. Các hệ thống bên ngoài có thể truy vấn dữ liệu này, đẩy cập nhật và tích hợp các sự kiện của Altium Workspace vào các quy trình nghiệp vụ doanh nghiệp rộng hơn. Việc truy cập dựa trên token; các thao tác chạy ở phía máy chủ mà không cần Altium Designer đang mở hoặc có người dùng hiện diện.

Đây là điểm tích hợp phù hợp cho mọi trường hợp sử dụng mà một hệ thống bên ngoài cần trao đổi dữ liệu với Altium 365 theo cách lập trình được – bảng điều khiển, đồng bộ ERP, pipeline báo cáo tùy chỉnh, hệ thống kiểm toán và tự động hóa chạy bên ngoài môi trường thiết kế.

Các mẫu tích hợp phổ biến

• Data extraction and reporting – kéo dữ liệu linh kiện, nội dung BOM, siêu dữ liệu dự án và trạng thái vòng đời vào các hệ thống báo cáo bên ngoài, bảng điều khiển hoặc kho dữ liệu. Hữu ích cho khả năng hiển thị phục vụ quản lý kỹ thuật, lập kế hoạch thu mua và báo cáo tuân thủ cần dữ liệu từ Altium nhưng nằm trong một hệ thống riêng.

• ERP and inventory synchronization – đẩy các thay đổi vòng đời linh kiện và danh sách linh kiện được phê duyệt từ Altium 365 sang ERP. Kéo dữ liệu vật tư được phê duyệt và dữ liệu tồn kho vào Altium để hiển thị trong môi trường thiết kế. API là lớp đồng bộ giữa hai hệ thống.

• Automation pipelines – kích hoạt các hành động tiếp theo khi sự kiện xảy ra trong Altium 365 – một thiết kế được phát hành, trạng thái vòng đời của linh kiện thay đổi, một đợt rà soát dự án hoàn tất. API cho phép các hệ thống điều phối bên ngoài phản hồi theo trạng thái của Altium Workspace mà không cần polling hoặc kích hoạt thủ công.

• Custom tooling and portals – xây dựng các công cụ nội bộ hiển thị dữ liệu Altium trong những ngữ cảnh mà giao diện Workspace đầy đủ không phù hợp – cổng phê duyệt linh kiện, bảng điều khiển trạng thái phát hành, góc nhìn thu mua chỉ hiển thị dữ liệu mà bộ phận thu mua cần. API cung cấp lớp dữ liệu; công cụ của bạn cung cấp giao diện.

• User and permission management – quản lý thành viên Workspace, cấp độ truy cập và cấu trúc nhóm theo cách lập trình được. Hữu ích cho các tổ chức mà việc cấp phát Altium Workspace cần được đồng bộ với một hệ thống nhận dạng hoặc nhân sự trung tâm.

Những gì API không thay thế

API Altium 365 cung cấp quyền truy cập vào dữ liệu và thao tác ở cấp Workspace. API này không cung cấp mô hình trình biên tập thiết kế – các phần tử PCB, đối tượng sơ đồ nguyên lý, cấu trúc liên kết net – vốn nằm bên trong Altium Designer. Với các trường hợp sử dụng cần truy cập dữ liệu ở cấp thiết kế trong một phiên chỉnh sửa đang hoạt động, Altium Designer SDK là công cụ phù hợp. Với các trường hợp sử dụng cần truy cập các phần tử thiết kế PCB để xử lý tiếp ở hạ nguồn, API dữ liệu thiết kế Nexar cung cấp một đường truy cập riêng.

Các lưu ý về cách tiếp cận tích hợp

• Token management – API sử dụng xác thực dựa trên token. Personal access token được gắn phạm vi theo người dùng và quy các hành động cho người dùng đó. Application token được gắn phạm vi theo một ứng dụng được đặt tên và phù hợp cho các pipeline tự động và tích hợp máy chủ với máy chủ. Hãy chọn dựa trên việc tích hợp đó đại diện cho một con người thực hiện hành động hay một hệ thống thực hiện hành động.

• Eventual consistency – trong một số trường hợp, các thay đổi dữ liệu Workspace được lan truyền bất đồng bộ. Các tích hợp phụ thuộc vào trạng thái thời gian thực nên tính đến độ trễ giữa lúc thay đổi xảy ra và lúc thay đổi đó hiển thị qua API.

• Error handling and retries – các tích hợp dùng trong môi trường production nên triển khai logic thử lại với backoff cho các lỗi tạm thời. Các thao tác Workspace có tính bền vững, nhưng điều kiện mạng và giới hạn tốc độ thì không được đảm bảo.