Przewodnik szybkiego startu z API Octopart
Octopart API to interfejs API GraphQL udostępniający dane dotyczące łańcucha dostaw komponentów elektronicznych. Zapewnia programistyczny dostęp do bazy danych Octopart — komponentów, cen, stanów magazynowych, ofert dystrybutorów, fabrycznych terminów realizacji i innych informacji — obejmującej miliony komponentów od tysięcy producentów i dystrybutorów z całego świata.
Ten przewodnik pozwoli Ci w kilka minut przejść od zera do pierwszego zapytania do Octopart API.
Wymagania wstępne
Konto w Altium Developer Center — samoobsługowym portalu Altium dla programistów, w którym 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 programistów
Krok 1: Uzyskaj dane uwierzytelniające
-
Zaloguj się w portal.nexar.com.
-
Utwórz nową aplikację.
-
Skopiuj Client ID i Client Secret — obie wartości będą potrzebne do uzyskania tokenu.
Krok 2: Uzyskaj token dostępu
Wymień dane uwierzytelniające na token dostępu, korzystając z mechanizmu przyznawania uprawnień client_credentials w OAuth 2.0:
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"
Odpowiedź na prawidłowo wykonane żądanie wygląda następująco:
{
"access_token": "eyJhbGci...",
"expires_in": 86400,
"token_type": "Bearer"
}
Skopiuj wartość access_token. Tokeny wygasają po 24 godzinach — informacje o obsłudze odświeżania tokenów w aplikacji znajdziesz w sekcji Uwierzytelnianie.
Krok 3: Wykonaj pierwsze zapytanie
Wyślij zapytanie GraphQL do punktu końcowego, umieszczając token 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 } } } } }"
}'
Odpowiedź na prawidłowo wykonane zapytanie zawiera pasujące komponenty:
{
"data": {
"supSearchMpn": {
"hits": 42,
"results": [
{
"part": {
"mpn": "LM358DR",
"manufacturer": { "name": "Texas Instruments" }
}
}
]
}
}
}
Pole hits wskazuje liczbę pasujących komponentów. Użyj limit i start, aby przeglądać kolejne strony wyników — zobacz Stronicowanie w Octopart API. Wszystkie opcje filtrowania, sortowania i agregacji znajdziesz w opisie supSearchMpn w dokumentacji Octopart API.
Wypróbuj w przeglądarce
Możesz interaktywnie wykonywać i analizować zapytania w środowisku Nitro IDE, dostępnym bezpośrednio pod adresem punktu końcowego GraphQL:
https://api.nexar.com/graphql
Aby przeglądać schemat w formie graficznej, otwórz przeglądarkę Voyager:
https://api.nexar.com/ui/voyager
Kolejne kroki
-
Przejrzyj dokumentację Octopart API: znajdziesz w niej wszystkie zapytania i typy, pogrupowane według obszarów.
-
Autoryzacja — wygasanie tokenów, ponowne uzyskiwanie tokenów i zarządzanie danymi uwierzytelniającymi
-
Wyszukiwanie — dopasowywanie numerów MPN, wyszukiwanie według słów kluczowych, filtry, region i waluta
-
Przykładowe zapytania — gotowe do wykonania zapytania dla typowych zastosowań
-
Osadź wyszukiwarkę komponentów na swojej stronie za pomocą Stock Locator Tool lub poznaj aplikację demonstracyjną Octopart API.