Altium 365 API 快速入门指南

Altium 365 API 让您能够以编程方式访问工作区数据，包括项目、BOM、元件、符号、封装等。它采用 GraphQL API，这意味着您可以通过单次请求精确查询所需的数据。

本指南将帮助您从零开始，在几分钟内完成首次 API 调用。

前提条件

• 一个 Altium 365 工作区

• 一个工作区管理员账户

• 一个 Altium 开发者中心账户 – 这是 Altium 面向开发者的自助服务门户，您可以在此加入相关计划，以获取 Altium 365 API、Altium Designer SDK、嵌入式查看器及其他开发者产品的访问权限

步骤 1：创建令牌

要授权 API 请求，您需要一个访问令牌。请在工作区的 Admin → Developer 下创建令牌。

创建令牌时，您可以从以下两个选项中进行选择。

选项 A：长期访问令牌

这是最简单的入门方式。您将获得一个有效期可配置（最长为 1 年）的访问令牌，可直接将其用于 API 请求。

适用于：快速探索、脚本，以及以简单易用为首要目标的集成。

有关详细信息，请参阅使用访问令牌。

选项 B：刷新令牌（建议用于生产环境）

这是一种更安全的方式。您将获得一个 refresh token，以及一个 client ID 和一个 client secret。通过编程方式将刷新令牌换取为短期访问令牌，然后使用该访问令牌发起 API 请求。刷新令牌本身的有效期可配置，最长为 1 年。

适用于：自动化集成、后台服务，以及在生产环境中全天候运行的任何应用。

有关换取流程，请参阅使用刷新令牌。

步骤 2：发起首次 API 请求

探索 Altium 365 API 的最快方式是使用内置的浏览器 IDE（由 Nitro 提供支持）。请访问：

https://{workspace-subdomain}.365.altium.com/api/graphql/

将 {workspace-subdomain} 替换为您实际的工作区子域名，例如 https://my-company.365.altium.com/api/graphql。

授权请求

所有 API 请求都需要在 Authorization HTTP 标头中使用 Bearer 方案传递访问令牌：

Authorization: Bearer {access-token}

运行首次查询

建议从列出工作区项目的查询开始：

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

将其粘贴到 IDE 中，点击 Run，您应该就能在响应中看到工作区项目。

您还可以通过以下地址以可视化方式探索完整的 API 架构：

https://{workspace-subdomain}.365.altium.com/api/voyager

后续步骤

• 浏览 GitHub 上的 AltiumDeveloper 组织，获取演示应用和查询示例

• 参阅使用访问令牌，了解如何在代码和脚本中使用令牌

• 参阅使用刷新令牌，了解如何实现自动化集成