Altium 365 API
Altium 365 API 是一种 GraphQL API，可让您通过编程方式访问 Altium 365 工作区数据。它支持对整个平台执行读取和写入操作。
API 的组织方式
API 围绕平台的各个领域进行组织，这些领域称为bounded contexts。每个限界上下文涵盖平台的一个特定领域，包括其实体、操作和业务规则。GraphQL 类型和查询名称遵循反映其所属领域的命名约定，因此在熟悉结构后，您可以更轻松地浏览架构。
主要限界上下文
限界上下文 |
涵盖内容 |
Design |
PCB 项目、原理图、变体、发布版本、制造数据包 |
Library |
元件、符号、封装、器件、器件申请、数据手册 |
Procurement |
物料清单、BOM 条目、备选器件和替代器件 |
Platform |
用户、工作区、组织、生命周期定义、修订版命名 |
Collaboration |
评论、评论线程、任务 |
Customization |
工作流、脚本、脚本执行 |
其他限界上下文涵盖更专业的功能，包括 设备建模、固件空中更新、需求管理、嵌入式软件和系统设计。这些功能可通过同一 API 访问，并遵循相同的约定。
随着文档覆盖范围的扩展，每个限界上下文都将拥有专属的文档章节。在此期间，内置的 Voyager 架构浏览器是探索完整类型关系图的便捷工具。
端点
区域端点
当操作范围内不涉及工作区时，例如需要列出用户有权访问的所有工作区，或者在处理用户和组织等全局数据时，请使用区域端点。
区域 |
GraphQL |
文件服务 |
Voyager（架构探索） |
欧洲 |
|
|
https://eur.365.altium.com/api/voyager |
美国西部 |
|
|
https://usw.365.altium.com/api/voyager |
美国东部 |
|
|
https://use.365.altium.com/api/voyager |
亚太地区 |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
工作区端点
与工作区专属资源交互时，建议从工作区端点开始。API 端点使用相同的工作区域名，并可通过编程方式发现，参见列出工作区示例。
GraphQL |
文件服务 |
Voyager（架构探索） |
|
|
https://{workspace-domain}/api/voyager |
探索架构
Altium 365 API 具有自描述能力。您可以直接通过工作区 URL 访问以下两个内置工具：
-
Nitro – 基于浏览器的 GraphQL IDE，用于以交互方式编写和运行查询：
https://{workspace-domain}/api/graphql/ -
Voyager – 完整架构的可视化关系图，有助于理解类型之间的关系：
https://{workspace-domain}/api/voyager/
身份验证
所有请求都必须包含有效的访问令牌：
Authorization: Bearer {access-token}
详情请参见使用访问令牌。
本节内容
AI 翻译