API de Altium 365
La API de Altium 365 es una API GraphQL que proporciona acceso programático a los datos de su espacio de trabajo de Altium 365. Admite operaciones de lectura y escritura en todas las áreas de la plataforma.
Cómo se organiza la API
La API se estructura en torno a las áreas de dominio de la plataforma, conocidas como bounded contexts. Cada contexto delimitado abarca un área específica de la plataforma: sus entidades, operaciones y reglas de negocio. Los nombres de los tipos y las consultas de GraphQL siguen convenciones de nomenclatura que reflejan el área de dominio a la que pertenecen, lo que facilita la navegación por el esquema una vez que se familiariza con la estructura.
Principales contextos delimitados
Contexto delimitado |
Qué abarca |
Design |
Proyectos de PCB, esquemas, variantes, versiones publicadas, paquetes de fabricación |
Library |
Componentes, símbolos, huellas, piezas, solicitudes de piezas, hojas de datos |
Procurement |
Listas de materiales, elementos de la BOM, piezas alternativas y de sustitución |
Platform |
Usuarios, espacios de trabajo, organizaciones, definiciones del ciclo de vida, nomenclatura de revisiones |
Collaboration |
Comentarios, hilos de comentarios, tareas |
Customization |
Flujos de trabajo, scripts, ejecuciones de scripts |
Otros contextos delimitados abarcan funciones más especializadas: modelado de dispositivos, actualizaciones inalámbricas de firmware, gestión de requisitos, software embebido y diseño de sistemas. Se puede acceder a ellos mediante la misma API y siguen las mismas convenciones.
Cada contexto delimitado tendrá su propia sección de documentación a medida que se amplíe la cobertura. Mientras tanto, el explorador de esquemas integrado Voyager es una buena forma de explorar el grafo completo de tipos.
Endpoints
Endpoints regionales
Utilice un endpoint regional cuando no tenga un espacio de trabajo dentro del ámbito de la operación, por ejemplo, para listar todos los espacios de trabajo a los que un usuario tiene acceso, o cuando trabaje con datos globales, como usuarios y organizaciones.
Región |
GraphQL |
Servicio de archivos |
Voyager (exploración del esquema) |
Europa |
|
|
https://eur.365.altium.com/api/voyager |
Oeste de EE. UU. |
|
|
https://usw.365.altium.com/api/voyager |
Este de EE. UU. |
|
|
https://use.365.altium.com/api/voyager |
Asia-Pacífico |
|
|
https://asp.365.altium.com/api/voyager |
GovCloud |
|
|
https://use.365-gov.altium.com/api/voyager |
Endpoints del espacio de trabajo
Los endpoints del espacio de trabajo son el punto de partida recomendado para interactuar con los recursos específicos de un espacio de trabajo. Los endpoints de la API utilizan el mismo dominio del espacio de trabajo y se pueden descubrir mediante programación; consulte el ejemplo Listar espacios de trabajo.
GraphQL |
Servicio de archivos |
Voyager (exploración del esquema) |
|
|
https://{workspace-domain}/api/voyager |
Exploración del esquema
La API de Altium 365 es autodocumentada. Hay dos herramientas integradas disponibles directamente desde la URL de su espacio de trabajo:
-
Nitro – un IDE de GraphQL basado en navegador para escribir y ejecutar consultas de forma interactiva:
https://{workspace-domain}/api/graphql/ -
Voyager – un grafo visual del esquema completo, útil para comprender las relaciones entre tipos:
https://{workspace-domain}/api/voyager/
Autenticación
Todas las solicitudes deben incluir un token de acceso válido:
Authorization: Bearer {access-token}
Consulte Uso de un token de acceso para obtener más información.
En esta sección
Localizado por IA