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 年）を持つ単一のアクセストークンを受け取り、それを 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 ベース）を使用することです。次の URL にアクセスしてください:

https://{workspace-domain}.altium.com/svc/napi/gateway/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 スキーマは次の URL で視覚的に確認できます:

https://{workspace-domain}.altium.com/svc/napi/gateway/voyager/

次のステップ

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

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

• 自動化された統合については Using a Refresh Token を参照してください