Altium 365 API
Altium 365 API は、Altium 365 Workspace データにプログラムからアクセスできる GraphQL API です。プラットフォーム全体にわたって、読み取り操作と書き込み操作の両方をサポートしています。
API の構成
API は、bounded contexts と呼ばれるプラットフォームのドメイン領域を中心に構成されています。各 bounded context は、プラットフォーム内の特定の領域、そのエンティティ、操作、ビジネスルールを対象としています。GraphQL の型名およびクエリ名は、それぞれが属するドメイン領域を反映した命名規則に従っているため、この構造に慣れればスキーマをたどりやすくなります。
主な Bounded Context
Bounded Context |
対象範囲 |
Design |
PCB プロジェクト、回路図、バリアント、リリース、製造パッケージ |
Library |
コンポーネント、シンボル、フットプリント、部品、部品要求、データシート |
Procurement |
部品表、BOM 項目、代替部品および置換部品 |
Platform |
ユーザー、Workspace、組織、ライフサイクル定義、リビジョン命名 |
Collaboration |
コメント、コメントスレッド、タスク |
Customization |
ワークフロー、スクリプト、スクリプト実行 |
そのほかの bounded context では、より専門的な機能も扱います。 たとえば、デバイスモデリング、無線経由ファームウェア更新、requirements management、組み込みソフトウェア、システム設計などです。これらも同じ 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 が対象に含まれない場合、たとえばユーザーがアクセス可能なすべての Workspace を一覧表示する場合や、ユーザーや組織などのグローバルデータを扱う場合は、リージョナルエンドポイントを使用してください。
リージョン |
GraphQL |
Files Service |
ヨーロッパ |
|
|
米国西部 |
|
|
米国東部 |
|
|
アジア太平洋 |
|
|
Gov Cloud |
|
|
認証
すべてのリクエストには、有効なアクセストークンを含める必要があります:
Authorization: Bearer {access-token}
詳細については、アクセストークンの使用 を参照してください。
このセクションの内容
AI で翻訳