アクセストークンの使用

アクセス トークンは、Altium 365 API へのリクエストを認可するために使用されます。各リクエストでは、Authorization ヘッダーに bearer token として含めます。

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

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

  • Via exchange – リフレッシュ トークンを使用して短期有効のアクセス トークンを生成する

トークンの取得方法に関係なく、認可のパターンは同じです。

認可ヘッダー

Authorization: Bearer {access-token}

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

トークンの有効期限

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

Short-lived access tokens(リフレッシュ トークンの交換で取得したもの)は、短期間で期限切れになります。その場合は、リフレッシュ トークンを再度交換して新しいものを取得してください。詳細は リフレッシュ トークンの使用 を参照してください。

期限切れのトークンを使用すると、API リクエストは 401 Unauthorized を返します。

セキュリティ

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

  • 長時間実行される自動化統合では、リフレッシュ トークン方式を推奨します。短期有効のアクセス トークンを使うことで、万一トークンが漏えいした場合でも、影響を受ける期間を限定できます。

関連項目

 

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