Collegare un Workspace Altium 365 a sistemi esterni

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.

L'API di Altium 365 fornisce accesso lato server all'intera gamma di entità del Workspace: componenti, progetti, BOM, metadati di progetto, utenti, autorizzazioni e stato del ciclo di vita. I sistemi esterni possono interrogare questi dati, inviare aggiornamenti e integrare gli eventi del Workspace Altium in flussi di lavoro aziendali più ampi. L'accesso è basato su token; le operazioni vengono eseguite lato server senza richiedere che Altium Designer sia aperto o che sia presente un utente.

Questo è il punto di integrazione corretto per qualsiasi caso d'uso in cui un sistema esterno debba scambiare dati con Altium 365 in modo programmatico: dashboard, sincronizzazione ERP, pipeline di reporting personalizzate, sistemi di audit e automazione eseguita al di fuori dell'ambiente di progettazione.

Pattern di integrazione comuni

• Data extraction and reporting – estrarre dati dei componenti, contenuti della BOM, metadati di progetto e stato del ciclo di vita in sistemi di reporting esterni, dashboard o data warehouse. Utile per la visibilità della gestione ingegneristica, la pianificazione degli acquisti e il reporting di conformità che richiede dati da Altium ma risiede in un sistema separato.

• ERP and inventory synchronization – inviare a ERP le modifiche del ciclo di vita dei componenti e gli elenchi di parti approvate da Altium 365. Importare in Altium materiali approvati e dati di inventario per visualizzarli nell'ambiente di progettazione. L'API è il livello di sincronizzazione tra i due sistemi.

• Automation pipelines – attivare azioni a valle quando si verificano eventi in Altium 365 – un progetto viene rilasciato, lo stato del ciclo di vita di un componente cambia, una revisione del progetto viene completata. L'API consente ai sistemi di orchestrazione esterni di rispondere allo stato del Workspace Altium senza polling o trigger manuali.

• Custom tooling and portals – creare strumenti interni che presentano i dati Altium in contesti in cui l'interfaccia completa del Workspace non è appropriata – un portale di approvazione componenti, una dashboard dello stato di rilascio, una vista acquisti che mostra solo i dati necessari agli acquisti. L'API fornisce il livello dati; il tuo strumento fornisce l'interfaccia.

• User and permission management – gestire in modo programmatico i membri del Workspace, i livelli di accesso e la struttura del team. Utile per le organizzazioni in cui il provisioning del Workspace Altium deve rimanere sincronizzato con un sistema centrale di identità o HR.

Cosa l'API non sostituisce

L'API di Altium 365 fornisce accesso a dati e operazioni a livello di Workspace. Non espone il modello dell'editor di progettazione – primitive PCB, oggetti schematici, topologia delle net – che risiede all'interno di Altium Designer. Per i casi d'uso che richiedono accesso ai dati a livello di progettazione durante una sessione di modifica attiva, l'SDK di Altium Designer è lo strumento appropriato. Per i casi d'uso che richiedono accesso alle primitive di progettazione PCB per elaborazioni a valle, l'API dati di progettazione Nexar fornisce un percorso di accesso separato.

Considerazioni sull'approccio di integrazione

• Token management – l'API utilizza autenticazione basata su token. I personal access token sono associati all'utente e attribuiscono le azioni a quell'utente. Gli application token sono associati a un'applicazione denominata e sono adatti per pipeline automatizzate e integrazioni server-to-server. Scegli in base al fatto che l'integrazione rappresenti l'azione di una persona o di un sistema.

• Eventual consistency – in alcuni casi le modifiche ai dati del Workspace si propagano in modo asincrono. Le integrazioni che dipendono dallo stato in tempo reale devono tenere conto della latenza tra il verificarsi di una modifica e la sua visibilità tramite l'API.

• Error handling and retries – le integrazioni di produzione dovrebbero implementare una logica di retry con backoff per gli errori transitori. Le operazioni del Workspace sono affidabili, ma le condizioni di rete e i limiti di frequenza non sono garantiti.