Altium 365 API 빠른 시작 가이드

Altium 365 API를 사용하면 Workspace 데이터(프로젝트, BOM, 컴포넌트, 심볼, 풋프린트 등)에 프로그래밍 방식으로 액세스할 수 있습니다. 이 API는 GraphQL API이므로, 단일 요청으로 필요한 데이터만 정확히 조회할 수 있습니다.

이 가이드는 몇 분 안에 처음 API 호출을 할 수 있도록 처음부터 안내합니다.

사전 요구 사항

• Altium 365 Workspace

• Workspace 관리자 계정

• Altium Developer Center 의 계정 – 개발자를 위한 Altium의 셀프서비스 포털로, 여기에서 Altium 365 API, Altium Designer SDK, Embeddable Viewer 및 기타 개발자 제품에 액세스하기 위한 프로그램에 등록할 수 있습니다.

1단계: 토큰 생성

API 요청을 인증하려면 액세스 토큰이 필요합니다. 토큰은 Workspace의 Admin → Developer 아래에서 생성됩니다.

토큰을 생성할 때는 다음 두 가지 옵션 중에서 선택할 수 있습니다.

옵션 A: 장기 유효 액세스 토큰

가장 간단하게 시작하는 방법입니다. 구성 가능한 유효 기간(최대 1년)을 가진 단일 액세스 토큰이 발급되며, 이를 API 요청에 직접 사용합니다.

적합한 용도: 빠른 탐색, 스크립트, 그리고 단순성이 중요한 통합 작업.

자세한 내용은 Using an Access token을 참조하세요.

옵션 B: 리프레시 토큰(운영 환경 권장)

보다 안전한 접근 방식입니다. refresh token와 함께 client ID 및 client secret가 발급됩니다. 리프레시 토큰은 프로그래밍 방식으로 단기 유효 액세스 토큰으로 교환되며, 이 액세스 토큰이 API 요청에 사용됩니다. 리프레시 토큰 자체의 유효 기간도 구성할 수 있으며(최대 1년), 설정 가능합니다.

적합한 용도: 자동화된 통합, 백그라운드 서비스, 그리고 24시간 연중무휴로 운영 환경에서 실행되는 모든 항목.

교환 흐름은 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 조직을 살펴보세요.

• 코드와 스크립트에서 토큰을 사용하는 방법은 Using an Access Token을 참조하세요.

• 자동화된 통합은 Using a Refresh Token 을 참조하세요.