Guide de démarrage rapide de l’API Altium 365

L’API Altium 365 vous donne un accès programmatique aux données de votre Workspace – projets, nomenclatures (BOM), composants, symboles, empreintes, et bien plus encore. Il s’agit d’une API GraphQL, ce qui signifie que vous pouvez interroger exactement les données dont vous avez besoin en une seule requête.

Ce guide vous permet de passer de zéro à votre premier appel d’API en quelques minutes.

Prérequis

• Un Workspace Altium 365

• Un compte administrateur du Workspace

• Un compte sur Altium Developer Center – le portail en libre-service d’Altium pour les développeurs, où vous pouvez vous inscrire à des programmes pour accéder à l’API Altium 365, au SDK Altium Designer, à Embeddable Viewer et à d’autres produits développeur

Étape 1 : Créer un jeton

Pour autoriser les requêtes API, vous avez besoin d’un jeton d’accès. Les jetons sont créés dans votre Workspace sous Admin → Developer.

Lors de la création d’un jeton, vous pouvez choisir entre les deux options suivantes.

Option A : Jeton d’accès longue durée

La manière la plus simple de commencer. Vous recevez un jeton d’accès unique avec une durée de validité configurable (jusqu’à 1 an). Utilisez-le directement dans les requêtes API.

Idéal pour : exploration rapide, scripts et intégrations où la simplicité est prioritaire.

Voir Using an Access token pour plus de détails.

Option B : Jeton d’actualisation (recommandé pour la production)

Une approche plus sécurisée. Vous recevez un refresh token avec un client ID et un client secret. Le jeton d’actualisation est échangé par programmation contre un jeton d’accès de courte durée, qui est ensuite utilisé dans les requêtes API. Le jeton d’actualisation lui-même a une durée de validité configurable (jusqu’à 1 an).

Idéal pour : intégrations automatisées, services d’arrière-plan et tout ce qui s’exécute en production 24 h/24, 7 j/7.

Voir Using a Refresh Token pour le flux d’échange.

Étape 2 : Effectuer votre première requête API

Le moyen le plus rapide d’explorer l’API Altium 365 est d’utiliser l’IDE de navigateur intégré (basé sur Nitro). Accédez à :

https://{workspace-domain}.altium.com/api/graphql/

Remplacez {workspace-domain} par le domaine réel de votre Workspace (par exemple, mycompany.altium.com).

Autoriser votre requête

Toutes les requêtes API nécessitent un jeton d’accès transmis dans l’en-tête HTTP Authorization avec le schéma Bearer :

Authorization: Bearer {access-token}

Exécuter votre première requête

Une bonne première requête consiste à lister les projets de votre Workspace :

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Collez-la dans l’IDE, cliquez sur Run, et vous devriez voir les projets de votre Workspace dans la réponse.

Vous pouvez également explorer visuellement le schéma complet de l’API à l’adresse suivante :

https://{workspace-domain}.altium.com/api/voyager

Étapes suivantes

• Parcourez l’organisation GitHub AltiumDeveloper pour découvrir des applications de démonstration et des exemples de requêtes

• Voir Using an Access Token pour l’utilisation des jetons dans le code et les scripts

• Voir Using a Refresh Token pour les intégrations automatisées