Краткое руководство по началу работы с API Octopart

Краткий обзор

Начните работу с Octopart API — API на основе GraphQL для получения данных о цепочках поставок электронных компонентов: от характеристик до цен и складских запасов. Это краткое руководство поможет вам получить учетные данные, запросить токен доступа и выполнить первый запрос на поиск компонента. В нем также приведены браузерные инструменты и ссылки для дальнейшего изучения. Читайте дальше, чтобы выполнить свой первый запрос к Octopart API.

- Узнайте, как получить Client ID и Client Secret и запросить токен доступа OAuth 2.0.
- Выполните GraphQL-запрос для поиска по артикулу производителя и разберитесь в полученных результатах.
- Найдите инструменты для изучения запросов и схемы API, а также справочные материалы для дальнейшей работы.
Узнайте больше с ИИ:

Octopart API — это API на основе GraphQL для доступа к данным о цепочках поставок электронных компонентов. Он предоставляет программный доступ к базе данных Octopart: сведениям о компонентах, ценам, складским остаткам, предложениям дистрибьюторов, срокам поставки с завода и другим данным о миллионах компонентов от тысяч производителей и дистрибьюторов по всему миру.

Это руководство поможет вам с нуля выполнить первый запрос к Octopart API всего за несколько минут.

Предварительные требования

Учетная запись в Altium Developer Center — портале самообслуживания Altium для разработчиков, где можно зарегистрироваться в программах для получения доступа к Altium 365 API, Octopart API, Altium Designer SDK, Embeddable Viewer и другим продуктам для разработчиков

Шаг 1. Получите учетные данные

  1. Войдите на portal.nexar.com.

  2. Создайте новое приложение.

  3. Скопируйте Client ID и Client Secret — оба значения понадобятся для запроса токена.

Your Client Secret is shown once. Сохраните их в надежном месте, прежде чем покинуть страницу.

Шаг 2. Получите токен доступа

Обменяйте учетные данные на токен доступа, используя тип предоставления доступа client_credentials протокола 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"

Пример успешного ответа:

{
  "access_token": "eyJhbGci...",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Скопируйте значение access_token. Срок действия токенов составляет 24 часа. О том, как реализовать обновление токенов в приложении, см. раздел «Аутентификация».

Шаг 3. Выполните первый запрос

Отправьте GraphQL-запрос на конечную точку, указав токен в заголовке 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 } } } } }"
  }'

При успешном выполнении запроса в ответе возвращаются найденные компоненты:

{
  "data": {
    "supSearchMpn": {
      "hits": 42,
      "results": [
        {
          "part": {
            "mpn": "LM358DR",
            "manufacturer": { "name": "Texas Instruments" }
          }
        }
      ]
    }
  }
}

Поле hits показывает количество найденных компонентов. Используйте limit и start для постраничного просмотра результатов — см. раздел Постраничная навигация в Octopart API. Все доступные фильтры, параметры сортировки и агрегации см. в описании supSearchMpn  в справочнике Octopart API.

Попробуйте в браузере

Вы можете выполнять и исследовать запросы в интерактивном режиме в среде Nitro IDE, доступной непосредственно по адресу конечной точки GraphQL:

https://api.nexar.com/graphql

Для визуального изучения схемы откройте браузер Voyager:

https://api.nexar.com/ui/voyager

Следующие шаги

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Contents
Contents