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

L’API Altium 365 vous permet d’accéder par programmation aux données de votre espace de travail : projets, nomenclatures, composants, symboles, empreintes et bien plus encore. Il s’agit d’une API GraphQL : vous pouvez donc obtenir exactement les données dont vous avez besoin en une seule requête.

Ce guide vous permet de partir de zéro et d’effectuer votre premier appel API en quelques minutes.

Prérequis

• Un espace de travail Altium 365

• Un compte administrateur de l’espace de travail

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

É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 espace de travail 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 de validité

Le moyen le plus simple de commencer. Vous recevez un seul jeton d’accès dont la durée de validité est configurable (jusqu’à 1 an). Utilisez-le directement dans les requêtes API.

Idéal pour : une exploration rapide, les scripts et les intégrations privilégiant la simplicité.

Consultez Utiliser un jeton d’accès pour plus de détails.

Option B : jeton de renouvellement (recommandé pour la production)

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

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

Consultez Utiliser un jeton de renouvellement pour connaître la procédure d’échange.

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

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

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

Remplacez {workspace-subdomain} par le sous-domaine réel de votre espace de travail, ce qui donne, par exemple, https://my-company.365.altium.com/api/graphql.

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

Pour commencer, vous pouvez utiliser une requête qui répertorie les projets de votre espace de travail :

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

Collez-la dans l’IDE, cliquez sur Run et les projets de votre espace de travail devraient apparaître dans la réponse.

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

https://{workspace-subdomain}.365.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

• Consultez Utiliser un jeton d’accès pour utiliser des jetons dans du code et des scripts

• Consultez Utiliser un jeton de renouvellement pour les intégrations automatisées