Korzystanie z tokenu dostępu

Token dostępu autoryzuje żądania do API Altium 365. Należy dołączać go do każdego żądania jako token bearer w nagłówku Authorization.

Tokeny dostępu można uzyskać na dwa sposoby:

• Directly – gdy utworzysz długoterminowy token dostępu w Admin → Developer

• Via exchange – gdy użyjesz tokenu odświeżania do wygenerowania krótkoterminowego tokenu dostępu

Wzorzec autoryzacji jest taki sam niezależnie od sposobu uzyskania tokenu.

Nagłówek autoryzacji

Authorization: Bearer {access-token}

Przykład: curl

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

Wygaśnięcie tokenu

Long-lived access tokens wygasają po upływie okresu ważności ustawionego podczas tworzenia (maksymalnie 1 rok). Po wygaśnięciu konieczne będzie utworzenie nowego tokenu w Admin → Developer.

Short-lived access tokens (uzyskane w wyniku wymiany tokenu odświeżania) wygasają po krótkim czasie. Gdy to nastąpi, ponownie wymień token odświeżania, aby uzyskać nowy — zobacz Korzystanie z tokenu odświeżania.

Wygasły token powoduje, że żądania API zwracają 401 Unauthorized.

Bezpieczeństwo

• Nie osadzaj tokenów dostępu w kodzie po stronie klienta ani nie zapisuj ich w systemie kontroli wersji.

• W przypadku długotrwałych, zautomatyzowanych integracji preferowane jest podejście z użyciem tokenu odświeżania – krótkoterminowe tokeny dostępu ograniczają czas narażenia na ryzyko, jeśli token zostanie przejęty.

Zobacz także

• Korzystanie z tokenu odświeżania