Altium 365 API クイックスタートガイド

Altium 365 APIは現在クローズドベータ版であり、一部の選定された早期アクセスのお客様のみが利用できます。

Altium 365 APIを使用すると、プロジェクト、BOM、コンポーネント、シンボル、フットプリントなどのワークスペースデータにプログラムからアクセスできます。GraphQL APIのため、1回のリクエストで必要なデータだけを正確に取得できます。

このガイドでは、初めての方でも数分で最初のAPI呼び出しを行えるように手順を説明します。

前提条件

  • Altium 365ワークスペース

  • ワークスペースの管理者アカウント

  • Altium Developer Centerのアカウント – Altium Developer Centerは開発者向けのセルフサービスポータルです。プログラムに登録することで、Altium 365 API、Altium Designer SDK、Embeddable Viewerなどの開発者向け製品にアクセスできます。

ステップ1:トークンを作成する

APIリクエストを認可するには、アクセストークンが必要です。トークンは、ワークスペースのAdmin → Developerで作成します。

トークンを作成する際は、次の2つのオプションから選択できます。

オプションA:長期有効アクセストークン

最も簡単に始められる方法です。有効期間を設定可能な(最大1年間)アクセストークンが1つ発行されます。APIリクエストでそのまま使用できます。

適した用途:簡単な動作確認、スクリプト、シンプルさを優先する連携。

詳細は、アクセストークンの使用を参照してください。

オプションB:リフレッシュトークン(本番環境に推奨)

より安全な方法です。refresh tokenが、client IDおよびclient secretとともに発行されます。リフレッシュトークンをプログラムで短期有効アクセストークンに交換し、そのアクセストークンをAPIリクエストで使用します。リフレッシュトークン自体の有効期間は設定可能です(最大1年間)。

適した用途:自動化された連携、バックグラウンドサービス、本番環境で24時間365日稼働するシステム。

交換フローについては、リフレッシュトークンの使用を参照してください。

Your tokens are shown once. 作成時には、すべてのトークンと認証情報が画面に表示されます。コピーして安全に保管してください。Altiumはトークンを保存しないため、ページを離れると再表示できません。

ステップ2:最初のAPIリクエストを送信する

Altium 365 APIを最も手軽に試すには、組み込みのブラウザーIDE(Nitroを採用)を使用します。次のURLにアクセスしてください。

https://{workspace-subdomain}.365.altium.com/api/graphql/

{workspace-subdomain}を実際のワークスペースのサブドメインに置き換えます。たとえば、https://my-company.365.altium.com/api/graphqlのようになります。

リクエストを認可する

すべてのAPIリクエストには、Authorization HTTPヘッダーでBearerスキームを使用して渡すアクセストークンが必要です。

Authorization: Bearer {access-token}

最初のクエリを実行する

まずは、ワークスペースのプロジェクトを一覧表示するクエリを試してみましょう。

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

IDEに貼り付けてRunをクリックすると、レスポンスにワークスペースのプロジェクトが表示されます。

このクエリのすべてのフィールドは、Altium 365 APIリファレンスに記載されています。使用可能なフィルター、並べ替え、ページングの引数については、 desProjects を参照してください。

次のURLでは、APIスキーマ全体を視覚的に確認することもできます。

https://{workspace-subdomain}.365.altium.com/api/voyager

次のステップ

 

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Contents
Contents