Guia de início rápido da API do Altium 365

A API do Altium 365 oferece acesso programático aos dados do seu Workspace — projetos, BOMs, componentes, símbolos, footprints e muito mais. É uma API GraphQL, o que significa que você pode consultar exatamente os dados de que precisa em uma única requisição.

Este guia leva você do zero à sua primeira chamada de API em minutos.

Pré-requisitos

• Um Workspace do Altium 365

• Uma conta de administrador do Workspace

• Uma conta no Altium Developer Center – portal de autoatendimento da Altium para desenvolvedores, onde você pode se inscrever em programas para acessar a API do Altium 365, o Altium Designer SDK, o Embeddable Viewer e outros produtos para desenvolvedores

Etapa 1: crie um token

Para autorizar requisições à API, você precisa de um token de acesso. Os tokens são criados no seu Workspace em Admin → Developer.

Ao criar um token, você pode escolher entre as duas opções a seguir.

Opção A: token de acesso de longa duração

A maneira mais simples de começar. Você recebe um único token de acesso com validade configurável (até 1 ano). Use-o diretamente nas requisições à API.

Ideal para: exploração rápida, scripts e integrações em que a simplicidade é a prioridade.

Consulte Como usar um token de acesso para obter detalhes.

Opção B: token de atualização (recomendado para produção)

Uma abordagem mais segura. Você recebe um refresh token junto com um client ID e um client secret. O token de atualização é trocado programaticamente por um token de acesso de curta duração, que é então usado nas requisições à API. O próprio token de atualização tem validade configurável (até 1 ano).

Ideal para: integrações automatizadas, serviços em segundo plano e qualquer aplicação executada em produção 24 horas por dia, 7 dias por semana.

Consulte Como usar um token de atualização para conhecer o fluxo de troca.

Etapa 2: faça sua primeira requisição à API

A maneira mais rápida de explorar a API do Altium 365 é pelo IDE integrado no navegador (baseado no Nitro). Acesse:

https://{workspace-subdomain}.365.altium.com/api/graphql/

Substitua {workspace-subdomain} pelo subdomínio real do seu Workspace, resultando, por exemplo, em https://my-company.365.altium.com/api/graphql.

Autorize sua requisição

Todas as requisições à API exigem um token de acesso enviado no cabeçalho HTTP Authorization com o esquema Bearer:

Authorization: Bearer {access-token}

Execute sua primeira consulta

Uma boa consulta inicial é listar os projetos do seu Workspace:

query {
  desProjects(first: 10) {
    nodes {
      id
      name
      description
    }
  }
}

Cole-a no IDE, clique em Run e você deverá ver os projetos do seu Workspace na resposta.

Você também pode explorar visualmente o esquema completo da API em:

https://{workspace-subdomain}.365.altium.com/api/voyager

Próximas etapas

• Explore a organização AltiumDeveloper no GitHub para encontrar aplicativos de demonstração e exemplos de consultas

• Consulte Como usar um token de acesso para usar tokens em código e scripts

• Consulte Como usar um token de atualização para integrações automatizadas