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 typu bearer w nagłówku Authorization.

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

• Directly – tworząc długoterminowy token dostępu w sekcji Admin → Developer

• Via exchange – używając tokenu odświeżania do wygenerowania krótkoterminowego tokenu dostępu (który nie będzie widoczny w sekcji Admin → Developer)

Schemat 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}/api/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 ich tworzenia (maksymalnie 1 rok). Po wygaśnięciu trzeba utworzyć nowy token w sekcji Admin → Developer.

Short-lived access tokens (uzyskane poprzez wymianę tokenu odświeżania) wygasają po krótkim czasie. Gdy to nastąpi, ponownie wymień token odświeżania, aby uzyskać nowy token dostępu – zobacz Korzystanie z tokenu odświeżania.

Wygasły token powoduje, że żądania do API zwracają 401 Unauthorized lub 200 OK z kodem błędu AuthExpiredToken w odpowiedzi GraphQL.

Bezpieczeństwo

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

• W przypadku długotrwałych, zautomatyzowanych integracji wybieraj podejście oparte na tokenie odświeżania – krótkoterminowe tokeny dostępu ograniczają czas narażenia w razie przejęcia tokenu.

Zobacz także

• Korzystanie z tokenu odświeżania