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