Guía de inicio rápido de la API de Altium 365

La API de Altium 365 te brinda acceso programático a los datos de tu Workspace: proyectos, BOM, componentes, símbolos, footprints y más. Es una API GraphQL, lo que significa que puedes consultar exactamente los datos que necesitas en una sola solicitud.

Esta guía te lleva de cero a tu primera llamada a la API en minutos.

Requisitos previos

• Un Workspace de Altium 365

• Una cuenta de administrador del Workspace

• Una cuenta en Altium Developer Center – el portal de autoservicio de Altium para desarrolladores, donde puedes inscribirte en programas para acceder a Altium 365 API, Altium Designer SDK, Embeddable Viewer y otros productos para desarrolladores

Paso 1: Crear un token

Para autorizar solicitudes a la API, necesitas un token de acceso. Los tokens se crean en tu Workspace en Admin → Developer.

Al crear un token, puedes elegir entre las dos opciones siguientes.

Opción A: Token de acceso de larga duración

La forma más sencilla de comenzar. Recibes un único token de acceso con una duración configurable (hasta 1 año). Úsalo directamente en las solicitudes a la API.

Bueno para: exploración rápida, scripts e integraciones donde la simplicidad es la prioridad.

Consulta Using an Access token para obtener más detalles.

Opción B: Refresh Token (recomendado para producción)

Un enfoque más seguro. Recibes un refresh token junto con un client ID y un client secret. El refresh token se intercambia mediante programación por un token de acceso de corta duración, que luego se utiliza en las solicitudes a la API. El propio refresh token tiene una duración configurable (hasta 1 año).

Bueno para: integraciones automatizadas, servicios en segundo plano y cualquier cosa que se ejecute en producción 24/7.

Consulta Using a Refresh Token para conocer el flujo de intercambio.

Paso 2: Haz tu primera solicitud a la API

La forma más rápida de explorar Altium 365 API es mediante el IDE integrado del navegador (impulsado por Nitro). Ve a:

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

Sustituye {workspace-domain} por el dominio real de tu Workspace (por ejemplo, mycompany.altium.com).

Autoriza tu solicitud

Todas las solicitudes a la API requieren un token de acceso enviado en el encabezado HTTP Authorization con el esquema Bearer:

Authorization: Bearer {access-token}

Ejecuta tu primera consulta

Una buena consulta inicial es listar los proyectos de tu Workspace:

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

Pégala en el IDE, haz clic en Run y deberías ver los proyectos de tu Workspace en la respuesta.

También puedes explorar visualmente el esquema completo de la API en:

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

Siguientes pasos

• Explora la organización de GitHub AltiumDeveloper para ver aplicaciones de demostración y consultas de ejemplo

• Consulta Using an Access Token para usar tokens en código y scripts

• Consulta Using a Refresh Token para integraciones automatizadas