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