Guia de Início Rápido da API Octopart

A API Octopart é uma API GraphQL para dados da cadeia de suprimentos de componentes eletrônicos. Ela fornece acesso programático ao banco de dados da Octopart – peças, preços, níveis de estoque, ofertas de distribuidores, prazos de entrega de fábrica e muito mais – abrangendo milhões de componentes de milhares de fabricantes e distribuidores no mundo todo.

Este guia leva você do zero até sua primeira consulta à API Octopart em minutos.

Pré-requisitos

Uma conta no Altium Developer Center – o portal de autoatendimento da Altium para desenvolvedores, onde você pode se inscrever em programas para acessar a API do Altium 365, a API Octopart, o SDK do Altium Designer, o Embeddable Viewer e outros produtos para desenvolvedores

Etapa 1: Obtenha credenciais

1. Faça login em portal.nexar.com.

2. Crie uma nova aplicação.

3. Copie o Client ID e o Client Secret – você precisará de ambos para solicitar um token.

Etapa 2: Obtenha um token de acesso

Troque suas credenciais por um token de acesso usando a concessão 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"

Uma resposta bem-sucedida se parece com isto:

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

Copie o valor de access_token. Os tokens expiram após uma hora – consulte Authentication para saber como lidar com a renovação de tokens em sua aplicação.

Etapa 3: Execute sua primeira consulta

Envie uma consulta GraphQL para o endpoint usando seu token no cabeçalho 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 } } } } }"
  }'

Uma resposta bem-sucedida retorna as peças correspondentes:

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

O campo hits mostra quantas peças corresponderam. Use limit e start para paginar os resultados – consulte Pagination in Octopart API.

Experimente no navegador

Você pode executar e explorar consultas de forma interativa no Nitro IDE, disponível diretamente no endpoint GraphQL:

https://api.nexar.com/graphql

Para explorar o esquema visualmente, abra o navegador Voyager:

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

Próximos passos

• Authorization – expiração de token, nova solicitação de tokens e gerenciamento de credenciais

• Search – correspondência de MPN, pesquisa por palavra-chave, filtros, região e moeda

• Example Queries – consultas prontas para uso em casos de uso comuns