Altium 365 API
Altium 365 API は、Altium 365 Workspace データにプログラムからアクセスするための GraphQL API です。プラットフォーム全体にわたって、読み取りと書き込みの両方の操作をサポートしています。
API の構成
API は、bounded contexts と呼ばれるプラットフォームのドメイン領域を中心に構成されています。各 bounded context は、プラットフォーム内の特定領域、つまりそのエンティティ、操作、およびビジネスルールを扱います。GraphQL の型名およびクエリ名は、それぞれが属するドメイン領域を反映した命名規則に従っているため、構造に慣れればスキーマをたどりやすくなります。
主な Bounded Contexts
Bounded Context |
対象範囲 |
Design |
PCB プロジェクト、回路図、バリアント、リリース、製造パッケージ |
Library |
コンポーネント、シンボル、フットプリント、パーツ、パーツ要求、データシート |
Procurement |
BOM、BOM アイテム、代替パーツおよび置換パーツ |
Platform |
ユーザー、Workspaces、組織、ライフサイクル定義、リビジョン命名 |
Collaboration |
コメント、コメントスレッド、タスク |
Customization |
ワークフロー、スクリプト、スクリプト実行 |
そのほかの bounded context では、より専門的な機能もカバーしています。たとえば、デバイスモデリング、無線経由のファームウェア更新、要件管理、組み込みソフトウェア、システム設計などです。これらも同じ API からアクセスでき、同じ規則に従っています。
各 bounded context には、対応範囲の拡大に合わせて専用のドキュメントセクションが用意される予定です。それまでは、組み込みの Voyager スキーマブラウザーを使うと、型グラフ全体を確認できます。
スキーマの探索
Altium 365 API は自己記述型です。Workspace URL から直接利用できる組み込みツールが 2 つあります。
-
Nitro – クエリを対話的に記述・実行できる、ブラウザベースの GraphQL IDE:
https://{workspace-domain}/api/graphql/ -
Voyager – スキーマ全体の視覚的なグラフ。型どうしの関係を把握するのに便利です:
https://{workspace-domain}/api/voyager/
エンドポイント
Workspace エンドポイント
ほとんどの統合では、Workspace エンドポイントを使用します。これは特定の Workspace を対象とし、最初の利用先として推奨されます。
|
GraphQL |
Files Service |
Workspace |
|
|
リージョン別エンドポイント
Workspace が対象に含まれない場合、たとえばユーザーがアクセス可能なすべての Workspaces を一覧表示する場合や、ユーザーや組織などのグローバルデータを扱う場合には、リージョン別エンドポイントを使用します。
リージョン |
GraphQL |
Files Service |
ヨーロッパ |
|
|
米国西部 |
|
|
米国東部 |
|
|
アジア太平洋 |
|
|
GovCloud |
|
|
認証
すべてのリクエストには、有効なアクセストークンを含める必要があります。
Authorization: Bearer {access-token}
詳細については、Using an Access Token を参照してください。
このセクションの内容
AI で翻訳