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 アイテム、代替部品および置換部品 |
Platform |
ユーザー、Workspaces、組織、ライフサイクル定義、リビジョン命名 |
Collaboration |
コメント、コメントスレッド、タスク |
Customization |
ワークフロー、スクリプト、スクリプト実行 |
さらに、より専門的な機能を対象とする bounded context もあります。たとえば、デバイスモデリング、無線経由のファームウェア更新、要件管理、組み込みソフトウェア、システム設計などです。これらも同じ API から利用でき、同じ規則に従っています。
各 bounded context には、対応範囲の拡大に応じて専用のドキュメントセクションが用意されます。それまでは、組み込みの Voyager スキーマブラウザーを使って、型グラフ全体を確認するのがお勧めです。
スキーマの探索
Altium 365 API は自己記述型です。Workspace URL から直接利用できる組み込みツールが 2 つあります。
-
Nitro – ブラウザー上で GraphQL クエリを対話的に作成・実行できる 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 |
ヨーロッパ |
|
|
米国西部 |
|
|
米国東部 |
|
|
アジア太平洋 |
|
|
Gov Cloud |
|
|
認証
すべてのリクエストには、有効なアクセストークンを含める必要があります。
Authorization: Bearer {access-token}詳細については、Using an Access Token を参照してください。
このセクションの内容
AI で翻訳