Verwendung eines Zugriffstokens

Ein Zugriffstoken autorisiert Anfragen an die Altium 365 API. Sie übergeben es bei jeder Anfrage als Bearer-Token im Authorization-Header.

Zugriffstoken können auf zwei Arten bezogen werden:

• Directly – indem Sie unter Admin → Developer ein langlebiges Zugriffstoken erstellen

• Via exchange – indem Sie mit einem Refresh-Token ein kurzlebiges Zugriffstoken generieren (das nicht unter Admin → Developer aufgeführt wird)

Das Autorisierungsschema ist unabhängig davon, wie das Token bezogen wurde.

Autorisierungsheader

Authorization: Bearer {access-token}

Beispiel: 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 } } }"}'

Token-Ablauf

Long-lived access tokens laufen nach der bei der Erstellung konfigurierten Gültigkeitsdauer (bis zu 1 Jahr) ab. Nach Ablauf müssen Sie unter Admin → Developer ein neues Token erstellen.

Short-lived access tokens (durch Austausch eines Refresh-Tokens erhalten) laufen nach kurzer Zeit ab. Tauschen Sie in diesem Fall Ihr Refresh-Token erneut aus, um ein neues Zugriffstoken zu erhalten – siehe Verwendung eines Refresh-Tokens.

Bei einem abgelaufenen Token geben API-Anfragen 401 Unauthorized oder 200 OK mit dem Fehlercode AuthExpiredToken in der GraphQL-Antwort zurück.

Sicherheit

• Betten Sie Zugriffstoken nicht in clientseitigen Code ein und checken Sie sie nicht in die Versionsverwaltung ein.

• Verwenden Sie für dauerhaft laufende, automatisierte Integrationen vorzugsweise Refresh-Token – kurzlebige Zugriffstoken begrenzen das Zeitfenster für einen möglichen Missbrauch, falls ein Token kompromittiert wird.

Siehe auch

• Verwendung eines Refresh-Tokens