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

Altium 365 API te ofrece acceso mediante programación a los datos de tu espacio de trabajo: proyectos, BOM, componentes, símbolos, huellas y mucho 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 permite empezar desde cero y realizar tu primera llamada a la API en cuestión de minutos.

Requisitos previos

• Un espacio de trabajo de Altium 365

• Una cuenta de administrador del espacio de trabajo

• 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: Crea un token

Para autorizar las solicitudes a la API, necesitas un token de acceso. Los tokens se crean en tu espacio de trabajo, 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 empezar. Recibes un único token de acceso con un período de validez configurable (hasta 1 año). Úsalo directamente en las solicitudes a la API.

Ideal para: exploraciones rápidas, scripts e integraciones en las que la simplicidad es la prioridad.

Consulta Uso de un token de acceso para obtener más información.

Opción B: Token de actualización (recomendado para producción)

Un método más seguro. Recibes un refresh token junto con un client ID y un client secret. El token de actualización 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 token de actualización tiene un período de validez configurable (hasta 1 año).

Ideal para: integraciones automatizadas, servicios en segundo plano y cualquier aplicación que funcione en producción de forma ininterrumpida.

Consulta Uso de un token de actualización para conocer el flujo de intercambio.

Paso 2: Realiza tu primera solicitud a la API

La forma más rápida de explorar Altium 365 API es a través del IDE integrado en el navegador (basado en Nitro). Accede a:

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

Sustituye {workspace-subdomain} por el subdominio real de tu espacio de trabajo para obtener, por ejemplo, https://my-company.365.altium.com/api/graphql.

Autoriza tu solicitud

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

Authorization: Bearer {access-token}

Ejecuta tu primera consulta

Una buena consulta para empezar es obtener una lista de los proyectos de tu espacio de trabajo:

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 espacio de trabajo en la respuesta.

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

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

Próximos pasos

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

• Consulta Uso de un token de acceso para utilizar tokens en código y scripts

• Consulta Uso de un token de actualización para integraciones automatizadas