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 からアクセスでき、同じ規則が適用されます。
各境界づけられたコンテキストには、Altium 365 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 |
スキーマの探索
-
API Reference – スキーマ全体を対象とした、閲覧・検索可能なAltium 365 API リファレンス。使用例も掲載されています。
-
Nitro – クエリを対話的に記述・実行するためのブラウザーベースの GraphQL IDE:
https://{workspace-domain}/api/graphql/ -
Voyager – スキーマ全体を視覚化したグラフ。型同士の関係を理解するのに役立ちます:
https://{workspace-domain}/api/voyager/
認証
すべてのリクエストには、有効なアクセストークンを含める必要があります:
Authorization: Bearer {access-token}
詳細は、アクセストークンの使用を参照してください。
関連リソース
-
Altium 365 API リファレンス – GraphQL の完全なリファレンス。
-
Altium 365 API リファレンス - llms.txt – AI コーディングアシスタント向けの、機械可読なリファレンスのインデックス。
-
Altium 認証ライブラリ – ユーザーのサインインに使用する OAuth2/OIDC + PKCE クライアントライブラリ。
-
GitHub の Altium Developer – SDK、サンプル、ドキュメントのソース。
このセクションの内容