アクセストークンの使用

アクセストークンは、Altium 365 APIへのリクエストを認可します。すべてのリクエストで、AuthorizationヘッダーにBearerトークンとして含めます。

アクセストークンは、次の2つの方法で取得できます。

  • Directly – Admin → Developerで長期有効なアクセストークンを作成する

  • Via exchange – リフレッシュトークンを使用して短期有効なアクセストークンを生成する(このトークンは Admin → Developerには表示されません)

トークンの取得方法にかかわらず、認可の方法は同じです。

認可ヘッダー

Authorization: Bearer {access-token}

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

トークンの有効期限

Long-lived access tokensは、作成時に設定した有効期間(最長1年)が経過すると失効します。失効後は、Admin → Developerで新しいトークンを作成する必要があります。

Short-lived access tokens(リフレッシュトークンの交換によって取得)は、短期間で失効します。その場合は、リフレッシュトークンを再度交換して新しいトークンを取得してください。リフレッシュトークンの使用を参照してください。

トークンが失効すると、APIリクエストは401 Unauthorizedを返すか、GraphQLレスポンスでエラーコードAuthExpiredToken を含む200 OKを返します。

セキュリティ

  • アクセストークンをクライアント側のコードに埋め込んだり、ソース管理にコミットしたりしないでください。

  • 長時間実行する自動連携では、リフレッシュトークン方式を推奨します。 短期有効なアクセストークンを使用することで、トークンが漏えいした場合でも、悪用される可能性のある期間を制限できます。

関連項目

 

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Contents
Contents