API Altium 365
L’API Altium 365 est une API GraphQL qui permet d’accéder par programmation aux données de votre espace de travail 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 un domaine 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 leur domaine d’appartenance, ce qui facilite la navigation dans le schéma une fois que vous connaissez la structure.
Principaux contextes délimités
Contexte délimité |
Périmètre couvert |
Design |
Projets PCB, schémas, variantes, versions publiées, dossiers 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, espaces de travail, 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 fonctionnalités plus spécialisées : modélisation des dispositifs, mises à jour du micrologiciel à distance, gestion des exigences, logiciels embarqués et conception de systèmes. 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 à mesure que la couverture s’étendra. En attendant, le navigateur de schéma intégré Voyager permet d’explorer l’intégralité du graphe des types.
Points de terminaison
Points de terminaison régionaux
Utilisez un point de terminaison régional lorsqu’aucun espace de travail n’est ciblé, par exemple pour répertorier tous les espaces de travail 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 |
Voyager (exploration du schéma) |
Europe |
|
|
https://eur.365.altium.com/api/voyager |
Ouest des États-Unis |
|
|
https://usw.365.altium.com/api/voyager |
Est des États-Unis |
|
|
https://use.365.altium.com/api/voyager |
Asie-Pacifique |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Points de terminaison de l’espace de travail
Les points de terminaison de l’espace de travail constituent le point de départ recommandé pour interagir avec les ressources propres à un espace de travail. Les points de terminaison de l’API utilisent le même domaine que l’espace de travail et peuvent être découverts par programmation. Consultez l’exemple Répertorier les espaces de travail.
GraphQL |
Service de fichiers |
Voyager (exploration du schéma) |
|
|
https://{workspace-domain}/api/voyager |
Exploration du schéma
L’API Altium 365 est autodocumentée. Deux outils intégrés sont disponibles directement depuis l’URL de votre espace de travail :
-
Nitro – un environnement de développement intégré GraphQL accessible dans un navigateur, pour écrire et exécuter des requêtes de manière interactive :
https://{workspace-domain}/api/graphql/ -
Voyager – un graphe visuel du schéma complet, utile pour comprendre les relations entre les types :
https://{workspace-domain}/api/voyager/
Authentification
Toutes les requêtes doivent inclure un jeton d’accès valide :
Authorization: Bearer {access-token}
Consultez Utilisation d’un jeton d’accès pour en savoir plus.
Dans cette section
Localisé par IA