Rechercher Rechercher dans la documentation

API Altium 365

Updated: August 26, 2026

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 à la fois les opérations de lecture et d’écriture sur l’ensemble de la plateforme.

New to Altium 365 API? Commencez par le guide de démarrage rapide pour créer votre premier jeton et effectuer votre premier appel d’API en quelques minutes.

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 comprise.

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 remplacement
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 d’appareils, mises à jour firmware OTA, gestion des exigences, logiciels embarqués 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’étend. Le navigateur de schéma intégré Voyager est un bon moyen d’explorer l’ensemble du graphe de types en attendant.

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 dans le 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/
```

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	`https://{workspace-domain}/api/graphql`	`https://{workspace-domain}/api/files`

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	`https://eur.365.altium.com/api/graphql`	`https://eur.365.altium.com/api/files`
Ouest des États-Unis	`https://usw.365.altium.com/api/graphql`	`https://usw.365.altium.com/api/files`
Est des États-Unis	`https://use.365.altium.com/api/graphql`	`https://use.365.altium.com/api/files`
Asie-Pacifique	`https://asp.365.altium.com/api/graphql`	`https://asp.365.altium.com/api/files`
GovCloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

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

Version imprimable

Localisé par IA

Si vous trouvez un problème, sélectionnez le texte/l’image et appuyez surCtrl + Enterpour nous envoyer vos commentaires.