Skrócony przewodnik rozpoczęcia pracy z API Octopart
Octopart API to interfejs API GraphQL dla danych łańcucha dostaw komponentów elektronicznych. Zapewnia programowy dostęp do bazy danych Octopart – części, cen, stanów magazynowych, ofert dystrybutorów, fabrycznych czasów realizacji i nie tylko – dla milionów komponentów od tysięcy producentów i dystrybutorów na całym świecie.
Ten przewodnik pozwoli Ci przejść od zera do wykonania pierwszego zapytania Octopart API w kilka minut.
Wymagania wstępne
Konto w Altium Developer Center – samoobsługowym portalu Altium dla deweloperów, gdzie możesz dołączyć do programów zapewniających dostęp do Altium 365 API, Octopart API, Altium Designer SDK, Embeddable Viewer i innych produktów dla deweloperów
Krok 1: Uzyskaj dane uwierzytelniające
-
Zaloguj się do portal.nexar.com.
-
Utwórz nową aplikację.
-
Skopiuj Client ID i Client Secret – oba będą potrzebne do żądania tokenu.
Krok 2: Uzyskaj token dostępu
Wymień swoje dane uwierzytelniające na token dostępu, używając grantu 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"
Pomyślna odpowiedź wygląda tak:
{
"access_token": "eyJhbGci...",
"expires_in": 86400,
"token_type": "Bearer"
}
Skopiuj wartość access_token. Tokeny wygasają po godzinie – zobacz sekcję Authentication, aby dowiedzieć się, jak obsługiwać odświeżanie tokenu w swojej aplikacji.
Krok 3: Uruchom swoje pierwsze zapytanie
Wyślij zapytanie GraphQL do punktu końcowego, używając tokenu w nagłówku 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 } } } } }"
}'
Pomyślna odpowiedź zwraca dopasowane części:
{
"data": {
"supSearchMpn": {
"hits": 42,
"results": [
{
"part": {
"mpn": "LM358DR",
"manufacturer": { "name": "Texas Instruments" }
}
}
]
}
}
}
Pole hits pokazuje, ile części zostało dopasowanych. Użyj limit i start, aby stronicować wyniki – zobacz Pagination in Octopart API.
Wypróbuj w przeglądarce
Możesz uruchamiać zapytania i eksplorować je interaktywnie w Nitro IDE, dostępnym bezpośrednio pod punktem końcowym GraphQL:
https://api.nexar.com/graphql
Aby wizualnie przeglądać schemat, otwórz przeglądarkę Voyager:
https://api.nexar.com/ui/voyager
Kolejne kroki
-
Authorization – wygasanie tokenu, ponowne żądanie tokenów i zarządzanie danymi uwierzytelniającymi
-
Search – dopasowywanie MPN, wyszukiwanie słów kluczowych, filtry, region i waluta
-
Example Queries – gotowe do uruchomienia zapytania dla typowych przypadków użycia