API de Altium 365

La API de Altium 365 es una API de GraphQL que proporciona acceso programático a los datos de su Workspace de Altium 365. Admite operaciones tanto de lectura como de escritura en todo el alcance de la plataforma.

New to Altium 365 API? Comience con la guía de inicio rápido para crear su primer token y realizar su primera llamada a la API en cuestión de minutos.

Cómo está organizada la API

La API está estructurada 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 tipos y 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 está familiarizado con la estructura.

Principales contextos delimitados

Contexto delimitado

Qué abarca

Design

Proyectos de PCB, esquemáticos, variantes, versiones, paquetes de fabricación

Library

Componentes, símbolos, huellas, piezas, solicitudes de piezas, hojas de datos

Procurement

Listas de materiales, elementos de BOM, piezas alternativas y sustitutas

Platform

Usuarios, Workspaces, organizaciones, definiciones de ciclo de vida, nomenclatura de revisiones

Collaboration

Comentarios, hilos de comentarios, tareas

Customization

Flujos de trabajo, scripts, ejecuciones de scripts

Los contextos delimitados adicionales cubren capacidades más especializadas: modelado de dispositivos, actualizaciones de firmware por aire, gestión de requisitos, software embebido y diseño de sistemas. Se puede acceder a estos a través de la misma API y siguen las mismas convenciones.

Cada contexto delimitado tendrá su propia sección de documentación dedicada a medida que se amplíe la cobertura. Mientras tanto, el navegador de esquemas integrado Voyager es una buena forma de explorar el gráfico completo de tipos.

Exploración del esquema

La API de Altium 365 es autoexplicativa. Hay dos herramientas integradas disponibles directamente desde la URL de su Workspace:

  • Nitro – un IDE de GraphQL basado en navegador para escribir y ejecutar consultas de forma interactiva:

    https://{workspace-domain}/api/graphql/
    
  • Voyager – un gráfico visual del esquema completo, útil para comprender las relaciones entre tipos:

    https://{workspace-domain}/api/voyager/
    

Endpoints

Endpoint del Workspace

Para la mayoría de las integraciones, use el endpoint del Workspace. Está dirigido a un Workspace específico y es el punto de partida recomendado:

 

GraphQL

Servicio de archivos

Workspace

https://{workspace-domain}/api/graphql

https://{workspace-domain}/api/files

Endpoints regionales

Use un endpoint regional cuando no tenga un Workspace en alcance; por ejemplo, para enumerar todos los Workspaces a los que un usuario tiene acceso, o cuando trabaje con datos globales como usuarios y organizaciones.

Región

GraphQL

Servicio de archivos

Europa

https://eur.365.altium.com/api/graphql

https://eur.365.altium.com/api/files

Oeste de EE. UU.

https://usw.365.altium.com/api/graphql

https://usw.365.altium.com/api/files

Este de EE. UU.

https://use.365.altium.com/api/graphql

https://use.365.altium.com/api/files

Asia-Pacífico

https://asp.365.altium.com/api/graphql

https://asp.365.altium.com/api/files

GovCloud

https://use.365-gov.altium.com/api/graphql

https://use.365-gov.altium.com/api/files

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 detalles.

En esta sección

 

AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Contenido