Altium 365 API 빠른 시작 가이드

Altium 365 API를 사용하면 프로젝트, BOM, 컴포넌트, 심볼, 풋프린트 등 워크스페이스 데이터에 프로그래밍 방식으로 액세스할 수 있습니다. GraphQL API이므로 한 번의 요청으로 필요한 데이터만 정확히 쿼리할 수 있습니다.

이 가이드를 따라 하면 처음 시작하는 경우에도 몇 분 안에 첫 API 호출을 실행할 수 있습니다.

사전 요구 사항

• Altium 365 워크스페이스

• 워크스페이스 관리자 계정

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

1단계: 토큰 생성

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

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

옵션 A: 장기 액세스 토큰

가장 간단하게 시작할 수 있는 방법입니다. 유효 기간을 설정할 수 있는 액세스 토큰 하나가 발급됩니다(최대 1년). 이 토큰을 API 요청에 직접 사용합니다.

적합한 용도: 간단한 탐색, 스크립트, 단순성이 우선인 통합.

자세한 내용은 액세스 토큰 사용을 참조하세요.

옵션 B: 갱신 토큰(프로덕션 환경에 권장)

더 안전한 방식입니다. refresh token이(가) client ID 및 client secret와(과) 함께 발급됩니다. 갱신 토큰을 프로그래밍 방식으로 단기 액세스 토큰으로 교환한 다음, 해당 액세스 토큰을 API 요청에 사용합니다. 갱신 토큰 자체의 유효 기간도 설정할 수 있습니다(최대 1년).

적합한 용도: 자동화된 통합, 백그라운드 서비스, 프로덕션 환경에서 연중무휴로 실행되는 모든 작업.

교환 흐름은 갱신 토큰 사용을 참조하세요.

2단계: 첫 API 요청 실행

Altium 365 API를 가장 빠르게 살펴보는 방법은 내장 브라우저 IDE(Nitro 기반)를 사용하는 것입니다. 다음 주소로 이동하세요.

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

{workspace-subdomain}을(를) 실제 워크스페이스 하위 도메인으로 바꾸세요. 예를 들면 https://my-company.365.altium.com/api/graphql과(와) 같습니다.

요청 인증

모든 API 요청에는 Bearer 스킴을 사용하여 Authorization HTTP 헤더에 전달되는 액세스 토큰이 필요합니다.

Authorization: Bearer {access-token}

첫 쿼리 실행

처음에는 워크스페이스의 프로젝트 목록을 조회하는 쿼리로 시작하는 것이 좋습니다.

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

이를 IDE에 붙여넣고 Run을(를) 클릭하면 응답에서 워크스페이스 프로젝트를 확인할 수 있습니다.

다음 주소에서 전체 API 스키마를 시각적으로 살펴볼 수도 있습니다.

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

다음 단계

• AltiumDeveloper GitHub 조직에서 데모 앱과 예제 쿼리를 살펴보세요.

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

• 자동화된 통합에 대해서는 갱신 토큰 사용을 참조하세요.