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 搭載）を使用することです。次へ移動します:

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 を参照してください