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

Altium 365 API は、Workspace データ（プロジェクト、BOM、コンポーネント、シンボル、フットプリントなど）にプログラムからアクセスできるようにします。これは GraphQL API であるため、必要なデータだけを 1 回のリクエストで正確に問い合わせることができます。

このガイドでは、ゼロの状態から数分で最初の API 呼び出しまで進めます。

前提条件

• Altium 365 Workspace

• Workspace の管理者アカウント

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

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

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

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

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

最も簡単に始められる方法です。設定可能な有効期間（最長 1 年）を持つ 1 つのアクセストークンを受け取り、それを API リクエストで直接使用します。

適している用途: 手早い確認、スクリプト、シンプルさを優先する連携

詳しくは Using an Access token を参照してください。

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

より安全な方法です。refresh token、client ID、client secret とあわせて受け取ります。リフレッシュトークンはプログラムによって短期間有効なアクセストークンに交換され、そのアクセストークンを API リクエストで使用します。リフレッシュトークン自体の有効期間も設定可能で、最長 1 年です。

適している用途: 自動化された連携、バックグラウンドサービス、24 時間 365 日稼働する本番環境のあらゆる処理

交換フローについては Using a Refresh Token を参照してください。

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

Altium 365 API を最も手早く試す方法は、組み込みのブラウザ IDE（Nitro を使用）を利用することです。次に移動します。

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

{workspace-domain} は実際の Workspace ドメインに置き換えてください（例: mycompany.altium.com）。

リクエストを認証する

すべての API リクエストでは、Authorization HTTP ヘッダーに Bearer スキームで渡されるアクセストークンが必要です:

Authorization: Bearer {access-token}

最初のクエリを実行する

開始用として適したクエリは、Workspace のプロジェクト一覧を取得するものです。

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

それを IDE に貼り付けて Run をクリックすると、レスポンスに Workspace のプロジェクトが表示されるはずです。

完全な API スキーマは、次の場所で視覚的に確認することもできます:

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

次のステップ

• デモアプリやクエリ例については、AltiumDeveloper GitHub organization を参照してください

• コードやスクリプトでのトークンの使用方法については Using an Access Token を参照してください

• 自動連携については Using a Refresh Token を参照してください