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. Trata-se de uma API GraphQL, o que significa que você pode consultar exatamente os dados de que precisa em uma única solicitação.

Este guia leva você do zero até 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 – o portal de autoatendimento da Altium para desenvolvedores, onde você pode se inscrever em programas para acessar a API do Altium 365, o SDK do Altium Designer, o Embeddable Viewer e outros produtos para desenvolvedores

Etapa 1: Criar um token

Para autorizar solicitações de 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 forma mais simples de começar. Você recebe um único token de acesso com tempo de validade configurável (até 1 ano). Use-o diretamente nas solicitações de API.

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

Consulte Using an Access token para obter detalhes.

Opção B: Refresh Token (recomendado para produção)

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

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

Consulte Using a Refresh Token para o fluxo de troca.

Etapa 2: Fazer sua primeira solicitação de API

A maneira mais rápida de explorar a API do Altium 365 é por meio da IDE integrada no navegador (desenvolvida com Nitro). Acesse:

https://{workspace-domain}.altium.com/svc/napi/gateway/graphql/

Substitua {workspace-domain} pelo domínio real do seu Workspace (por exemplo, mycompany.altium.com).

Autorize sua solicitação

Todas as solicitações de API exigem um token de acesso passado 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 na 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-domain}.altium.com/svc/napi/gateway/voyager/

Próximos passos

• Navegue pela organização do GitHub AltiumDeveloper para ver aplicativos de demonstração e consultas de exemplo

• Consulte Using an Access Token para usar tokens em código e scripts

• Consulte Using a Refresh Token para integrações automatizadas