下载PDF
根据您与 Altium 的关系,您可以通过 Altium Designer 或平台的浏览器界面体验 Altium 平台提供的服务。本页将介绍后者,并概述当您注册 Altium 帐户并登录Altium Platform Interface 时将看到的内容。 有关 Altium 365 平台安全性、可靠性、隐私和合规性的最新信息,请访问Altium 365 信任中心。 对于需要符合美国政府安全法规(如 ITAR 和 EAR)的组织,Altium 提供了基于美国的Altium 365 GovCloud ,在AWS GovCloud区域运行,并提供额外的数据保护措施。 ►更多信息,请参见Altium 365 GovCloud及其相关常见问题解答。 注册Altium账户 访问Altium软件和服务需要您有一个与您的电子邮件地址相关联的Altium Account 。如果您的公司还没有创建一个账户…
Altium 365 can host a Git repository for your project's source files. Altium Designer works with these repositories as a native client, but you can also work with them like any other Git remote — clone, pull, push, etc. with the standard Git client. This page shows how to: Discover a project's repository URL through the Altium 365 API. Authenticate Git requests using an Altium 365 access token…
Scopes define what an access token is authorized to do. The Altium 365 API validates scopes on every request – a token without the required scope for an operation will receive an authorization error. Scopes are assigned by the platform based on the context in which a token is issued. You don't select scopes manually, but you will encounter them when inspecting tokens and when working with the API…
刷新令牌流程是一种更安全的 API 请求授权方式。您无需直接使用单个长期有效的凭据,而是将刷新令牌交换为短期有效的访问令牌。当访问令牌过期时,再次进行交换。 请注意,刷新令牌不能 单独用于授权 API 请求;必须先将其 交换为刷新令牌。 要使用此流程,请在 Admin → Developer 中创建令牌时选择 refresh token 选项。创建时,您将获得三个值: Client ID – 标识您的集成 Client secret – 用于验证交换请求 Refresh token – 用于获取访问令牌 These credentials are shown once. 请复制并安全保存这三个值——Altium 不会存储这些值,您离开创建页面后也无法再次查看。请像保护密码一样保护刷新令牌和客户端密钥。 将刷新令牌交换为访问令牌 向 Altium Identity 令牌端点发送 POST…
访问令牌用于授权对 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…
Tokens are credentials used to authorize requests to the Altium 365 API. All API requests must include a valid token in the Authorization header. Tokens are created in your Workspace under Admin → Developer. Only Workspace administrators can create tokens. Tokens are shown once. At creation, the token value is displayed once and is never stored or retrievable by Altium. Copy and store it securely…
A GRID (Global Resource ID) is a globally unique, stable identifier for any entity on the Altium platform – a project, a component, a BOM, a task, and so on. Why GRIDs Exist Platform entities typically carry local identifiers (GUIDs, numeric IDs) that are unique only within their own context. A project GUID is not globally unique – two projects in different Workspaces can share the same GUID. A…
A realm is a named, isolated logical instance of Altium 365. Every Workspace belongs to exactly one realm, and all data within that Workspace is stored and processed within it. Why Realms Exist Altium 365 operates across multiple geographies and deployment models. Historically, the term region was used to refer to a single instance of Altium 365 per geography – one for Europe, one for the US, and…
Altium Identity 是 Altium 的 OAuth 2.0 和 OpenID Connect (OIDC) 身份提供程序。您的应用程序通过 Altium Identity 对用户进行身份验证,然后代表用户调用 Altium 365 API,全程无需处理用户的 Altium 密码。 应用程序使用 authorization-code flow 和 PKCE 登录。公共客户端(桌面、本地部署、原生、单页应用)使用 PKCE,无需客户端密钥;机密客户端(Web/服务器后端)则需添加客户端密钥。包含每个请求和响应的分步流程均托管在 GitHub 上,本页面将解释相关概念,帮助您选择合适的路径。 Full flows, code, and libraries → Altium Auth on GitHub. GitHub 项目是权威来源,提供语言无关的规范、共享的一致性测试套件…
This section takes a closer look at the following elements of the Altium 365 platform: Authentication – Altium Identity authentication flows Realms – each 'realm' is a named, isolated logical instance of Altium 365. GRID (Global Resource ID) – a globally unique, stable identifier for any entity on the Altium 365 platform. Tokens – credentials used to authorize requests to the Altium 365 API…
Learn More