API Altium 365
L’API Altium 365 est une API GraphQL qui fournit un accès programmatique aux données de votre Workspace Altium 365. Elle prend en charge les opérations de lecture et d’écriture sur l’ensemble de la plateforme.
Organisation de l’API
L’API est structurée autour des domaines fonctionnels de la plateforme, appelés bounded contexts. Chaque contexte délimité couvre une zone spécifique de la plateforme – ses entités, ses opérations et ses règles métier. Les noms des types et des requêtes GraphQL suivent des conventions de nommage qui reflètent le domaine fonctionnel auquel ils appartiennent, ce qui facilite la navigation dans le schéma une fois la structure assimilée.
Principaux contextes délimités
Contexte délimité |
Ce qu’il couvre |
Design |
Projets PCB, schémas, variantes, versions, packages de fabrication |
Library |
Composants, symboles, empreintes, pièces, demandes de pièces, fiches techniques |
Procurement |
Nomenclatures, éléments de nomenclature, pièces alternatives et de substitution |
Platform |
Utilisateurs, Workspaces, organisations, définitions de cycle de vie, nommage des révisions |
Collaboration |
Commentaires, fils de discussion, tâches |
Customization |
Workflows, scripts, exécutions de scripts |
D’autres contextes délimités couvrent des capacités plus spécialisées – modélisation de dispositifs, mises à jour de firmware over-the-air, gestion des exigences, logiciel embarqué et conception système. Ils sont accessibles via la même API et suivent les mêmes conventions.
Chaque contexte délimité disposera de sa propre section de documentation dédiée à mesure que la couverture s’étendra. En attendant, le navigateur de schéma intégré Voyager est un excellent moyen d’explorer le graphe complet des types.
Exploration du schéma
L’API Altium 365 est auto-documentée. Deux outils intégrés sont disponibles directement depuis l’URL de votre Workspace :
-
Nitro – un IDE GraphQL basé sur navigateur pour écrire et exécuter des requêtes de manière interactive :
https://{workspace-domain}/api/graphql/ -
Voyager – une représentation visuelle du graphe complet du schéma, utile pour comprendre les relations entre les types :
https://{workspace-domain}/api/voyager/
Points de terminaison
Point de terminaison du Workspace
Pour la plupart des intégrations, utilisez le point de terminaison du Workspace. Il cible un Workspace spécifique et constitue le point de départ recommandé :
|
GraphQL |
Service de fichiers |
Workspace |
|
|
Points de terminaison régionaux
Utilisez un point de terminaison régional lorsque vous n’avez pas de Workspace dans le périmètre – par exemple, pour lister tous les Workspaces auxquels un utilisateur a accès – ou lorsque vous travaillez avec des données globales telles que les utilisateurs et les organisations.
Région |
GraphQL |
Service de fichiers |
Europe |
|
|
Ouest des États-Unis |
|
|
Est des États-Unis |
|
|
Asie-Pacifique |
|
|
Gov Cloud |
|
|
Authentification
Toutes les requêtes doivent inclure un jeton d’accès valide :
Authorization: Bearer {access-token}
Voir Utilisation d’un jeton d’accès pour plus de détails.
Dans cette section
Localisé par IA