Kurzanleitung für die Octopart-API
Die Octopart API ist eine GraphQL-API für Lieferkettendaten elektronischer Bauteile. Sie bietet Ihnen programmatischen Zugriff auf die Octopart-Datenbank – Bauteile, Preise, Lagerbestände, Händlerangebote, Lieferzeiten ab Werk und mehr – mit Millionen von Bauteilen von Tausenden Herstellern und Händlern weltweit.
Mit dieser Anleitung gelangen Sie in wenigen Minuten von den ersten Schritten zu Ihrer ersten Octopart-API-Abfrage.
Voraussetzungen
Ein Konto im Altium Developer Center – dem Self-Service-Portal von Altium für Entwickler, in dem Sie sich für Programme registrieren können, um Zugriff auf die Altium 365 API, die Octopart API, das Altium Designer SDK, den Embeddable Viewer und weitere Entwicklerprodukte zu erhalten
Schritt 1: Zugangsdaten abrufen
-
Melden Sie sich bei portal.nexar.com an.
-
Erstellen Sie eine neue Anwendung.
-
Kopieren Sie Client ID und Client Secret – Sie benötigen beides, um ein Token anzufordern.
Schritt 2: Zugriffstoken abrufen
Tauschen Sie Ihre Zugangsdaten über den OAuth-2.0-Grant client_credentials gegen ein Zugriffstoken ein:
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"
Eine erfolgreiche Antwort sieht so aus:
{
"access_token": "eyJhbGci...",
"expires_in": 86400,
"token_type": "Bearer"
}
Kopieren Sie den Wert von access_token. Token laufen nach 24 Stunden ab – unter „Authentifizierung“ erfahren Sie, wie Sie die Token-Erneuerung in Ihrer Anwendung handhaben.
Schritt 3: Erste Abfrage ausführen
Senden Sie eine GraphQL-Abfrage an den Endpunkt und übergeben Sie Ihr Token im Header 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 } } } } }"
}'
Eine erfolgreiche Antwort gibt passende Bauteile zurück:
{
"data": {
"supSearchMpn": {
"hits": 42,
"results": [
{
"part": {
"mpn": "LM358DR",
"manufacturer": { "name": "Texas Instruments" }
}
}
]
}
}
}
Das Feld hits zeigt an, wie viele passende Bauteile gefunden wurden. Verwenden Sie limit und start, um die Ergebnisse seitenweise zu durchsuchen – siehe Paginierung in der Octopart API. Alle Filter-, Sortier- und Aggregationsoptionen finden Sie unter supSearchMpn in der Octopart-API-Referenz.
Im Browser ausprobieren
In der Nitro IDE, die direkt am GraphQL-Endpunkt verfügbar ist, können Sie Abfragen interaktiv ausführen und erkunden:
https://api.nexar.com/graphql
Um das Schema visuell zu erkunden, öffnen Sie den Voyager-Browser:
https://api.nexar.com/ui/voyager
Nächste Schritte
-
Durchsuchen Sie die Octopart-API-Referenz: alle Abfragen und Typen, nach Bereichen gruppiert.
-
Autorisierung – Ablauf von Token, erneutes Anfordern von Token und Verwalten von Zugangsdaten
-
Suche – MPN-Abgleich, Stichwortsuche, Filter, Region und Währung
-
Beispielabfragen – sofort ausführbare Abfragen für gängige Anwendungsfälle
-
Integrieren Sie die Bauteilsuche mit dem Stock Locator Tool in Ihre Website oder erkunden Sie die Demo-App der Octopart API.