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

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

このガイドでは、準備から初めてのAPI呼び出しまでを数分で進められます。

前提条件

• Altium 365ワークスペース

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

• Altium Developer Centerのアカウント – Altium Developer Centerは、Altiumが開発者向けに提供するセルフサービスポータルです。各種プログラムに登録することで、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日稼働する処理。

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

ステップ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をクリックすると、レスポンスにワークスペースのプロジェクトが表示されます。

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

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

次のステップ

• GitHubのAltiumDeveloper組織で、デモアプリやクエリのサンプルを確認する

• コードやスクリプトでのトークンの使用方法については、アクセストークンの使用を参照する

• 自動連携については、リフレッシュトークンの使用を参照する