Altium 365 API
Altium 365 APIは、Altium 365 WorkspaceのデータにプログラムからアクセスできるGraphQL APIです。プラットフォーム全体にわたって、読み取りと書き込みの両方の操作をサポートしています。
APIの構成
APIは、bounded contextsと呼ばれるプラットフォームのドメイン領域を中心に構成されています。各境界づけられたコンテキストは、プラットフォームの特定の領域におけるエンティティ、操作、ビジネスルールを扱います。GraphQLの型名とクエリ名は、所属するドメイン領域を反映した命名規則に従っているため、構造に慣れるとスキーマを容易に探索できます。
主な境界づけられたコンテキスト
境界づけられたコンテキスト |
対象範囲 |
Design |
PCBプロジェクト、回路図、バリアント、リリース、製造パッケージ |
Library |
コンポーネント、シンボル、フットプリント、部品、部品リクエスト、データシート |
Procurement |
部品表、BOM項目、代替部品および置換部品 |
Platform |
ユーザー、Workspace、組織、ライフサイクル定義、リビジョンの命名 |
Collaboration |
コメント、コメントスレッド、タスク |
Customization |
ワークフロー、スクリプト、スクリプトの実行 |
その他の境界づけられたコンテキストでは、デバイスモデリング、無線経由のファームウェア更新、要件管理、組み込みソフトウェア、システム設計など、より専門的な機能を扱います。これらも同じAPIからアクセスでき、同じ規則に従います。
ドキュメントの対象範囲が拡充されるにつれて、各境界づけられたコンテキストに専用のドキュメントセクションが設けられます。それまでは、組み込みのVoyagerスキーマブラウザーを使用すると、型グラフ全体を探索できます。
エンドポイント
リージョン別エンドポイント
特定のWorkspaceを対象としない場合（たとえば、ユーザーがアクセスできるすべてのWorkspaceを一覧表示する場合）や、ユーザーや組織などのグローバルデータを扱う場合は、リージョン別エンドポイントを使用してください。
リージョン |
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 |
Workspaceエンドポイント
Workspace固有のリソースを操作する際は、Workspaceエンドポイントから始めることをお勧めします。APIエンドポイントはWorkspaceと同じドメインを使用し、プログラムから取得できます。Workspaceの一覧表示の例を参照してください。
GraphQL |
ファイルサービス |
Voyager（スキーマの探索） |
|
|
https://{workspace-domain}/api/voyager |
スキーマの探索
Altium 365 APIには、API自体にドキュメントが組み込まれています。WorkspaceのURLから、次の2つの組み込みツールを直接利用できます。
-
Nitro – クエリを対話的に作成して実行するための、ブラウザーベースのGraphQL IDE：
https://{workspace-domain}/api/graphql/ -
Voyager – 型同士の関係を理解するのに役立つ、スキーマ全体を視覚化したグラフ：
https://{workspace-domain}/api/voyager/
認証
すべてのリクエストに、有効なアクセストークンを含める必要があります。
Authorization: Bearer {access-token}
詳細は、アクセストークンの使用 を参照してください。
このセクションの内容
AI で翻訳