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

Octopart API — это GraphQL API для данных о цепочке поставок электронных компонентов. Он предоставляет программный доступ к базе данных 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 — оба значения понадобятся для запроса токена.

Шаг 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. Срок действия токенов истекает через один час — сведения о том, как обрабатывать обновление токенов в приложении, см. в разделе «Аутентификация».

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

Отправьте GraphQL-запрос на endpoint, используя токен в заголовке 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.

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

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

https://api.nexar.com/graphql

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

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

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

• Авторизация — истечение срока действия токена, повторный запрос токенов и управление учетными данными

• Поиск — сопоставление MPN, поиск по ключевым словам, фильтры, регион и валюта

• Примеры запросов — готовые к запуску запросы для типовых сценариев использования