Altium 365 API
Altium 365 API는 사용자의 Altium 365 Workspace 데이터에 프로그래밍 방식으로 액세스할 수 있도록 하는 GraphQL API입니다. 이 API는 플랫폼 전반에 걸쳐 읽기 및 쓰기 작업을 모두 지원합니다.
API 구성 방식
API는 플랫폼의 도메인 영역을 중심으로 구성되며, 이를 bounded contexts라고 합니다. 각 bounded context는 플랫폼의 특정 영역(엔터티, 작업, 비즈니스 규칙)을 다룹니다. GraphQL 타입 및 쿼리 이름은 자신이 속한 도메인 영역을 반영하는 명명 규칙을 따르므로, 구조에 익숙해지면 스키마를 더 쉽게 탐색할 수 있습니다.
주요 Bounded Context
Bounded Context |
포함 내용 |
Design |
PCB 프로젝트, 회로도, 변형, 릴리스, 제조 패키지 |
Library |
컴포넌트, 심볼, 풋프린트, 부품, 부품 요청, 데이터시트 |
Procurement |
BOM, BOM 항목, 대체 부품 및 치환 부품 |
Platform |
사용자, Workspace, 조직, 라이프사이클 정의, 리비전 명명 |
Collaboration |
댓글, 댓글 스레드, 작업 |
Customization |
워크플로, 스크립트, 스크립트 실행 |
그 외의 bounded context는 보다 특화된 기능인 디바이스 모델링, OTA 펌웨어 업데이트, 요구사항 관리, 임베디드 소프트웨어, 시스템 설계를 다룹니다. 이들은 동일한 API를 통해 접근할 수 있으며 동일한 규칙을 따릅니다.
각 bounded context에는 문서 범위가 확장됨에 따라 전용 문서 섹션이 제공될 예정입니다. 그때까지는 기본 제공 Voyager 스키마 브라우저를 사용해 전체 타입 그래프를 탐색하는 것이 좋습니다.
스키마 탐색
Altium 365 API는 자체 문서화(self-documenting)를 지원합니다. 다음의 두 가지 기본 제공 도구를 Workspace URL에서 바로 사용할 수 있습니다.
-
Nitro – 브라우저 기반 GraphQL IDE로, 쿼리를 대화형으로 작성하고 실행할 수 있습니다:
https://{workspace-domain}/api/graphql/ -
Voyager – 전체 스키마의 시각적 그래프로, 타입 간 관계를 이해하는 데 유용합니다:
https://{workspace-domain}/api/voyager/
엔드포인트
Workspace 엔드포인트
대부분의 통합에서는 Workspace 엔드포인트를 사용합니다. 이 엔드포인트는 특정 Workspace를 대상으로 하며, 시작점으로 권장됩니다:
|
GraphQL |
Files Service |
Workspace |
|
|
지역별 엔드포인트
범위에 해당하는 Workspace가 없을 때(예: 사용자가 액세스할 수 있는 모든 Workspace 목록 조회) 또는 사용자 및 조직과 같은 전역 데이터를 다룰 때는 지역별 엔드포인트를 사용하세요.
지역 |
GraphQL |
Files Service |
유럽 |
|
|
미국 서부 |
|
|
미국 동부 |
|
|
아시아 태평양 |
|
|
Gov Cloud |
|
|
인증
모든 요청에는 유효한 액세스 토큰이 포함되어야 합니다:
Authorization: Bearer {access-token}
자세한 내용은 액세스 토큰 사용 을 참조하세요.
이 섹션의 내용
AI로 번역됨