使用访问令牌

访问令牌用于授权对 Altium 365 API 的请求。每次请求时,都需要在 Authorization 标头中将其作为 Bearer 令牌传递。

可以通过以下两种方式获取访问令牌:

  • Directly – 在管理 → 开发者中创建长期有效的访问令牌

  • Via exchange – 使用刷新令牌生成短期有效的访问令牌(此类令牌不会列在 管理 → 开发者中)

无论通过哪种方式获取令牌,授权方式都相同。

授权标头

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 年)结束后过期。过期后,您需要在管理 → 开发者中创建新令牌。

Short-lived access tokens(通过刷新令牌交换获取)会在短时间后过期。届时,请再次使用刷新令牌换取新的访问令牌,详见使用刷新令牌。

令牌过期会导致 API 请求返回 401 Unauthorized,或在 GraphQL 响应中返回 200 OK,并附带错误代码 AuthExpiredToken。

安全性

  • 请勿将访问令牌嵌入客户端代码或提交到源代码版本控制系统。

  • 对于长期运行的自动化集成,建议优先使用刷新令牌方式—— 短期有效的访问令牌可在令牌泄露时缩短风险暴露时间。

另请参阅

 

AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Contents
Contents