Guía de inicio rápido de la API de Octopart
La API de Octopart es una API de GraphQL para datos de la cadena de suministro de componentes electrónicos. Le brinda acceso programático a la base de datos de Octopart: piezas, precios, niveles de inventario, ofertas de distribuidores, plazos de entrega de fábrica y más, en millones de componentes de miles de fabricantes y distribuidores de todo el mundo.
Esta guía lo llevará desde cero hasta su primera consulta a la API de Octopart en cuestión de minutos.
Requisitos previos
Una cuenta en Altium Developer Center – el portal de autoservicio de Altium para desarrolladores, donde puede inscribirse en programas para acceder a Altium 365 API, Octopart API, Altium Designer SDK, Embeddable Viewer y otros productos para desarrolladores
Paso 1: Obtener credenciales
-
Inicie sesión en portal.nexar.com.
-
Cree una nueva aplicación.
-
Copie el Client ID y el Client Secret – necesitará ambos para solicitar un token.
Paso 2: Obtener un token de acceso
Intercambie sus credenciales por un token de acceso usando la concesión OAuth 2.0 client_credentials:
curl -X POST https://identity.nexar.com/connect/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=CLIENT_ID" \
-d "client_secret=CLIENT_SECRET" \
-d "scope=supply.domain"
Una respuesta exitosa se ve así:
{
"access_token": "eyJhbGci...",
"expires_in": 86400,
"token_type": "Bearer"
}
Copie el valor de access_token. Los tokens caducan después de una hora; consulte Autenticación para saber cómo gestionar la renovación de tokens en su aplicación.
Paso 3: Ejecutar su primera consulta
Envíe una consulta GraphQL al endpoint usando su token en el encabezado Authorization:
curl -X POST https://api.nexar.com/graphql \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"query": "query { supSearchMpn(q: \"LM358\", limit: 3) { hits results { part { mpn manufacturer { name } } } } }"
}'
Una respuesta exitosa devuelve las piezas coincidentes:
{
"data": {
"supSearchMpn": {
"hits": 42,
"results": [
{
"part": {
"mpn": "LM358DR",
"manufacturer": { "name": "Texas Instruments" }
}
}
]
}
}
}
El campo hits muestra cuántas piezas coincidieron. Use limit y start para paginar los resultados; consulte Paginación en la API de Octopart.
Pruébelo en el navegador
Puede ejecutar y explorar consultas de forma interactiva en Nitro IDE, disponible directamente en el endpoint GraphQL:
https://api.nexar.com/graphql
Para explorar visualmente el esquema, abra el navegador Voyager:
https://api.nexar.com/ui/voyager
Siguientes pasos
-
Autorización – caducidad del token, nueva solicitud de tokens y gestión de credenciales
-
Búsqueda – coincidencia de MPN, búsqueda por palabra clave, filtros, región y moneda
-
Consultas de ejemplo – consultas listas para ejecutar para casos de uso comunes