Utilisation d’un jeton d’accès

Un jeton d’accès autorise les requêtes à l’API Altium 365. Vous devez l’inclure dans chaque requête en tant que jeton Bearer dans l’en-tête Authorization.

Les jetons d’accès peuvent être obtenus de deux façons :

• Directly – lorsque vous créez un jeton d’accès à longue durée de vie dans Admin → Développeur

• Via exchange – lorsque vous utilisez un jeton d’actualisation pour générer un jeton d’accès à courte durée de vie (qui ne figurera pas sous Admin → Développeur)

Le mécanisme d’autorisation est le même, quelle que soit la façon dont le jeton a été obtenu.

En-tête d’autorisation

Authorization: Bearer {access-token}

Exemple : curl

curl -X POST https://{workspace-domain}/api/graphql/ \
  -H "Authorization: Bearer {access-token}" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ desProjects(first: 5) { nodes { id name } } }"}'

Expiration des jetons

Long-lived access tokens expirent à l’issue de la durée de validité que vous avez définie lors de leur création (jusqu’à 1 an). Une fois le jeton expiré, vous devrez en créer un nouveau dans Admin → Développeur.

Short-lived access tokens (obtenus par échange d’un jeton d’actualisation) expirent après une courte période. Lorsque cela se produit, échangez à nouveau votre jeton d’actualisation pour en obtenir un nouveau – voir Utilisation d’un jeton d’actualisation.

Un jeton expiré entraîne le renvoi de 401 Unauthorized par les requêtes API, ou de 200 OK avec le code d’erreur AuthExpiredToken dans la réponse GraphQL.

Sécurité

• N’intégrez pas de jetons d’accès dans le code côté client et ne les enregistrez pas dans un système de gestion de versions.

• Pour les intégrations automatisées fonctionnant sur de longues périodes, privilégiez l’utilisation d’un jeton d’actualisation – les jetons d’accès à courte durée de vie limitent la période d’exposition si un jeton est compromis.

Voir aussi

• Utilisation d’un jeton d’actualisation