API do Altium 365

Updated: May 21, 2026

Altium 365 API é uma API GraphQL que fornece acesso programático aos dados do seu Workspace do Altium 365. Ela oferece suporte a operações de leitura e gravação em toda a amplitude da plataforma.

New to Altium 365 API? Comece com o guia de início rápido para criar seu primeiro token e fazer sua primeira chamada de API em poucos minutos.

Como a API é organizada

A API é estruturada em torno das áreas de domínio da plataforma, conhecidas como bounded contexts. Cada contexto delimitado cobre uma área específica da plataforma – suas entidades, operações e regras de negócio. Os nomes de tipos e consultas GraphQL seguem convenções de nomenclatura que refletem a área de domínio à qual pertencem, facilitando a navegação pelo esquema quando você já está familiarizado com a estrutura.

Principais contextos delimitados

Contexto delimitado	O que ele cobre
Design	Projetos de PCB, esquemáticos, variantes, versões, pacotes de fabricação
Library	Componentes, símbolos, footprints, peças, solicitações de peças, fichas técnicas
Procurement	Listas de materiais, itens de BOM, peças alternativas e substitutas
Platform	Usuários, Workspaces, organizações, definições de ciclo de vida, nomenclatura de revisões
Collaboration	Comentários, tópicos de comentários, tarefas
Customization	Workflows, scripts, execuções de scripts

Contextos delimitados adicionais cobrem recursos mais especializados – modelagem de dispositivos, atualizações de firmware over-the-air, gerenciamento de requisitos, software embarcado e design de sistemas. Eles podem ser acessados pela mesma API e seguem as mesmas convenções.

Cada contexto delimitado terá sua própria seção de documentação dedicada à medida que a cobertura for expandida. Enquanto isso, o navegador de esquema Voyager integrado é uma boa forma de explorar o gráfico completo de tipos.

Explorando o esquema

Altium 365 API é autodocumentada. Duas ferramentas integradas estão disponíveis diretamente na URL do seu Workspace:

Nitro – um IDE GraphQL baseado em navegador para escrever e executar consultas de forma interativa:
```
https://{workspace-domain}/api/graphql/
```
Voyager – um gráfico visual do esquema completo, útil para entender os relacionamentos entre os tipos:
```
https://{workspace-domain}/api/voyager/
```

Endpoints

Endpoint do Workspace

Para a maioria das integrações, use o endpoint do Workspace. Ele tem como alvo um Workspace específico e é o ponto de partida recomendado:

	GraphQL	Serviço de arquivos
Workspace	`https://{workspace-domain}/api/graphql`	`https://{workspace-domain}/api/files`

Endpoints regionais

Use um endpoint regional quando você não tiver um Workspace no escopo – por exemplo, para listar todos os Workspaces aos quais um usuário tem acesso – ou ao trabalhar com dados globais, como usuários e organizações.

Região	GraphQL	Serviço de arquivos
Europa	`https://eur.365.altium.com/api/graphql`	`https://eur.365.altium.com/api/files`
Oeste dos EUA	`https://usw.365.altium.com/api/graphql`	`https://usw.365.altium.com/api/files`
Leste dos EUA	`https://use.365.altium.com/api/graphql`	`https://use.365.altium.com/api/files`
Ásia-Pacífico	`https://asp.365.altium.com/api/graphql`	`https://asp.365.altium.com/api/files`
Gov Cloud	`https://use.365-gov.altium.com/api/graphql`	`https://use.365-gov.altium.com/api/files`

Autenticação

Todas as solicitações devem incluir um token de acesso válido:

Authorization: Bearer {access-token}

Consulte Usando um token de acesso para mais detalhes.

Nesta seção

Versão para impressão

Localizado por IA

Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.