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

La API de Altium 365 le ofrece acceso programático a los datos de su Workspace: proyectos, BOM, componentes, símbolos, footprints y más. Es una API GraphQL, lo que significa que puede consultar exactamente los datos que necesita en una sola solicitud.

Esta guía le ayudará a pasar de cero a su primera llamada a la API en cuestión de 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 puede inscribirse en programas para acceder a la API de Altium 365, al SDK de Altium Designer, a Embeddable Viewer y a otros productos para desarrolladores

Paso 1: Crear un token

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

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

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

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

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

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

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

Un enfoque más seguro. Recibe un refresh token junto con un client ID y client secret. El refresh token se intercambia de forma programática por un token de acceso de corta duración, que luego se usa 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.

Consulte Using a Refresh Token para el flujo de intercambio.

Paso 2: Realice su primera solicitud a la API

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

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

Sustituya {workspace-domain} por su dominio real del Workspace (por ejemplo, mycompany.altium.com).

Autorice su solicitud

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

Authorization: Bearer {access-token}

Ejecute su primera consulta

Una buena consulta inicial es enumerar los proyectos de su Workspace:

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

Péguela en el IDE, haga clic en Run y debería ver los proyectos de su Workspace en la respuesta.

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

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

Siguientes pasos

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

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

• Consulte Using a Refresh Token para integraciones automatizadas