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の値をコピーします。トークンの有効期限は24時間です。アプリケーションでのトークン更新の処理方法については、「認証」を参照してください。
ステップ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を使用して、結果のページを切り替えられます。詳しくは、Octopart APIのページネーションを参照してください。利用可能なすべてのフィルター、並べ替え、集計のオプションについては、Octopart APIリファレンスの supSearchMpn を参照してください。
ブラウザーで試す
GraphQLエンドポイントから直接利用できるNitro IDEで、クエリを対話的に実行し、その動作を確認できます。
https://api.nexar.com/graphql
スキーマを視覚的に確認するには、Voyagerブラウザーを開きます。
https://api.nexar.com/ui/voyager
次のステップ
-
Octopart APIリファレンスを参照してください。すべてのクエリと型が分野別にまとめられています。
-
認可 – トークンの有効期限、トークンの再リクエスト、認証情報の管理
-
検索 – MPNの照合、キーワード検索、フィルター、地域、通貨
-
クエリの例 – 一般的なユースケースですぐに実行できるクエリ
-
在庫検索ツールを使用してサイトに部品検索を埋め込むか、Octopart APIデモアプリをお試しください。