API do Altium 365
A API do Altium 365 é uma API GraphQL que oferece 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 plataforma.
Como a API está organizada
A API é estruturada em torno das áreas de domínio da plataforma, conhecidas como bounded contexts. Cada contexto delimitado abrange 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 depois que você se familiarizar com a estrutura.
Principais contextos delimitados
Contexto delimitado |
O que abrange |
Design |
Projetos de PCB, esquemáticos, variantes, versões liberadas, pacotes de fabricação |
Library |
Componentes, símbolos, footprints, peças, solicitações de peças, folhas de dados |
Procurement |
Listas de materiais, itens da 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 |
Fluxos de trabalho, scripts, execuções de scripts |
Outros contextos delimitados abrangem recursos mais especializados — modelagem de dispositivos, atualizações de firmware sem fio, gerenciamento de requisitos, software embarcado e projeto de sistemas. Eles são acessíveis 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 se expandir. Enquanto isso, o navegador de esquemas integrado Voyager é uma boa maneira de explorar o grafo completo de tipos.
Endpoints
Endpoints regionais
Use um endpoint regional quando não houver 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 |
Voyager (exploração do esquema) |
Europa |
|
|
https://eur.365.altium.com/api/voyager |
Oeste dos EUA |
|
|
https://usw.365.altium.com/api/voyager |
Leste dos EUA |
|
|
https://use.365.altium.com/api/voyager |
Ásia-Pacífico |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Endpoints do Workspace
Os endpoints do Workspace são o ponto de partida recomendado para interagir com recursos específicos de um Workspace. Os endpoints da API usam o mesmo domínio do Workspace e podem ser descobertos programaticamente — consulte o exemplo Listar Workspaces.
GraphQL |
Serviço de arquivos |
Voyager (exploração do esquema) |
|
|
https://{workspace-domain}/api/voyager |
Explorando o esquema
A API do Altium 365 é 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 grafo visual do esquema completo, útil para entender as relações entre os tipos:
https://{workspace-domain}/api/voyager/
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 obter detalhes.
Nesta seção
Localizado por IA