Octopart API クイックスタートガイド
Octopart API は、電子部品サプライチェーンデータのための GraphQL API です。これにより、Octopart データベース(部品、価格、在庫レベル、ディストリビューターのオファー、工場リードタイムなど)へプログラムからアクセスできます。対象は、世界中の数千のメーカーおよびディストリビューターが扱う数百万点のコンポーネントにわたります。
このガイドでは、ゼロの状態から数分で最初の Octopart API クエリを実行できるようになります。
前提条件
Altium Developer Center のアカウント – 開発者向けの Altium セルフサービスポータルです。ここでは、Altium 365 API、Octopart API、Altium Designer SDK、Embeddable Viewer、そのほかの開発者向け製品にアクセスするためのプログラムに登録できます
ステップ 1: 認証情報を取得する
-
portal.nexar.com にサインインします。
-
新しいアプリケーションを作成します。
-
Client ID と Client Secret – をコピーします。トークンを要求する際に両方必要です。
ステップ 2: アクセストークンを取得する
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"
成功した場合のレスポンスは次のようになります。
{
"access_token": "eyJhbGci...",
"expires_in": 86400,
"token_type": "Bearer"
}
access_token の値をコピーしてください。トークンは 1 時間で期限切れになります。アプリケーションでのトークン更新の処理方法については、Authentication を参照してください。
ステップ 3: 最初のクエリを実行する
Authorization ヘッダーにトークンを指定して、エンドポイントに GraphQL クエリを送信します。
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 } } } } }"
}'
成功すると、一致した部品が返されます。
{
"data": {
"supSearchMpn": {
"hits": 42,
"results": [
{
"part": {
"mpn": "LM358DR",
"manufacturer": { "name": "Texas Instruments" }
}
}
]
}
}
}
hits フィールドには、一致した部品数が表示されます。結果をページ送りするには limit と start を使用してください。詳細は Pagination in Octopart API を参照してください。
ブラウザーで試す
クエリは、GraphQL エンドポイントから直接利用できる Nitro IDE で対話的に実行および確認できます。
https://api.nexar.com/graphql
スキーマを視覚的に確認するには、Voyager ブラウザーを開いてください。
https://api.nexar.com/ui/voyager
次のステップ
-
Authorization – トークンの有効期限、トークンの再取得、認証情報の管理
-
Search – MPN マッチング、キーワード検索、フィルター、地域、通貨
-
Example Queries – 一般的なユースケース向けの、そのまま実行できるクエリ