Die Nexar API erklärt: Was sie ist, wie sie funktioniert und was sie für die Menschen verändert, die sie nutzen

Zunächst einmal: Was ist eine API?

API steht für Application Programming Interface. Eine Person nutzt eine Website durch Klicken und Lesen. Ein Programm kann nicht klicken, daher braucht es ein Servicefenster, um eine präzise Frage zu stellen und eine präzise Antwort in einem Format zu erhalten, das es versteht. Dieses Fenster ist die API. Octopart ist eine Website, auf der unsere Nutzer nach elektronischen Bauteilen suchen und sie aus jedem Blickwinkel betrachten können. Diese Ansicht umfasst unter anderem, wer das Bauteil auf Lager hat, was es kostet, seinen Lifecycle-Status, technische Attribute und mehr. Sie können sogar nach einem Bauteil suchen, um zu sehen, welche anderen Bauteile ihm ähnlich sind. Die Nexar API liefert dieselben Informationen direkt in die geschäftlichen Softwaresysteme Ihres Unternehmens.

Vorteile der Nutzung der Nexar API

• Integration in Ihre eigenen Tools: Sie können aktuelle Daten aus der Nexar API direkt in interne Systeme einbetten, etwa in ein benutzerdefiniertes Purchase Order Management-System oder ein Product Lifecycle Management-System.
• Mehr als nur Lieferdaten: Neben Lieferinformationen ruft die Nexar API auch Designdaten aus Ihren Altium 365-Workspaces ab, sodass eine einzige Integration Beschaffungs- und Designdaten zusammenführen kann.
• Konsistenz über Teams hinweg: Jeder, der dieselbe Abfrage verwendet, erhält dieselben Werte zurück: denselben Preis, denselben Lagerbestand und dieselben Einheiten aus demselben Zeitpunkt. Zahlen bleiben zwischen Personen, Berichten und über die Zeit hinweg vergleichbar.
• Automatisierung im großen Maßstab: Mit der Nexar API können Sie programmgesteuert bis zu 100 Teile gleichzeitig abfragen und bis zu 300 Abfragen pro Minute ausführen (potenziell also 30.000 Teile in nur einer Minute analysieren!)

Die Nexar API

Die Nexar API besteht hauptsächlich aus: 

• Lieferdaten sind die Teileinformationen von Octopart: Die Beschaffungsseite der API bietet Zugriff auf mehr als 95 Millionen Teile, mit Lagerbestand, Preisen, Lifecycle-Status, Lieferzeit, Datenblättern, technischen Attributen, CAD-Modellen und Vorschlägen für ähnliche Teile, bezogen von Elektronikdistributoren und täglich aktualisiert. 

• Designdaten sind für Altium-Kunden gedacht und decken die Inhalte Ihrer Design-Workspaces ab, von Projekten bis hin zu Komponentendetails. Das Nexar-Datenmodell ist hier öffentlich wertvoll: Nexar Voyager. Im Datenmodell trägt jede Operation ein Präfix, das angibt, worauf sie zugreift: sup für Supply, des für Design und adm für Kontoverwaltung.

Beispiel 1: Sie beschreiben die Antwort, die Sie erhalten möchten

Nexar verwendet GraphQL, eine Abfragesprache für APIs. Bei anderen API-Infrastrukturen fordern Sie einen festen Datenblock an, erhalten alles und schreiben Code, um das zu verwerfen, was Sie nicht wollten. Mit GraphQL schreiben Sie die Form der Antwort aus, und genau diese Form kommt zurück. Hier ist die dokumentierte Form einer Suche nach MPN (manufacturer part number):

query MpnSearch { 

  supSearchMpn { 

    results { part { id  name  mpn } } 

  } 

} 

Laut vorgelesen: Führe eine Suche über Hersteller-Teilenummern aus, sage mir, wie viele Treffer es gab, und gib mir für jedes Ergebnis die Kennung, den Namen und die MPN des Teils. Nichts anderes wird zurückgegeben. Fordern Sie mehr an, erhalten Sie mehr. In einer Live-Demonstration von Altium führte die Suche nach einem RA0E2-Mikrocontroller aus der Renesas-RA-Familie zur Rückgabe des Teils; das Hinzufügen technischer Spezifikationen bestätigte, dass es als RoHS-konform (Restriction of Hazardous Substances) gekennzeichnet war; das Hinzufügen des Datenblatts lieferte einen Link zur Datei, ihren Namen und ihr Erstellungsdatum, weil Octopart die verfügbaren Datenblätter bewertet und das beste zurückgeben kann. Nichts davon kam an, bevor danach gefragt wurde.

Beispiel 2: mehrere Wege zur Suche

Ähnlich wie bei Octopart ist die Nexar API flexibel darin, wie Sie nach einer Komponente suchen können. Wenn Sie eine breitere Suche durchführen möchten, können Sie nach einer teilweisen MPN oder anhand von Schlüsselwörtern suchen. Wenn Sie genau wissen, was Sie möchten, können Sie nach der exakten MPN suchen.

Für die breitere Suche ist die Operation, die Sie in der API verwenden möchten, „supSearch“. Diese Operation führt eine Fuzzy-Match-Suche aus.

query search { 

  supSearch (q: "Current sensor") { 

    hits 

    results { 

      part { 

        id 

        name 

        shortDescription 

      } 

    } 

  } 

} 

Im obigen Beispiel würde die Suche nach „current sensor“ die Anzahl der Treffer, die IDs der Teile, die Namen und eine Kurzbeschreibung der Komponente zurückgeben. 

Die Operation „supMultiMatch“ akzeptiert eine Liste von bis zu 100 Teilen, identifiziert über MPN oder SKU (stock keeping unit), und löst sie gemeinsam auf. Im Gegensatz zu „supSearch“ werden bei der Verwendung von „SupMultiMatch“ alle Teiltreffer ignoriert. Diese Abfrage fragt zwei Komponenten ab:

query MultiSearch { 

  supMultiMatch (queries: [ 

      {mpn: "SY55855VKG", limit: 1}, 

      {mpn: "BAV99-7-F"}, 

  ]) { hits  parts { id  name  mpn } } 

} 

Jeder Eintrag kann eine Position einer BOM (bill of materials) sein, sodass eine ganze Stückliste bepreist werden kann, ohne dass jemand einen Browser öffnen muss. 

Beispiel 3: die Designseite und das Zurückschreiben von Daten

Design funktioniert auf dieselbe Weise. Operationen mit dem Präfix des, wie etwa „desWorkspaces“, greifen auf Ihre Altium 365-Workspaces zu. Da die Daten wie ein Graph strukturiert sind, folgen Sie Beziehungen von Ihrem Startpunkt aus nach außen: von einem Workspace zu den darin enthaltenen Designs und von einem Design zu dem, was es enthält — von Netzen und Komponentendetails bis hin zu MCAD (mechanical computer-aided design) und Positionsinformationen. Sie wählen, wie weit Sie gehen und wie viel Sie von jeder Station mitnehmen möchten.

Lesen ist nur die halbe Geschichte. Eine Mutation schreibt: etwa das Hinzufügen eines Kommentars oder das Hochladen eines Projekts. Wenn eine Operation eine Datei benötigt, senden Sie diese zuerst an den Nexar-Dateidienst unter files.nexar.com/File/Upload und übergeben dabei ein Token mit den Scopes design.domain, user.access und openid. Zurück kommt eine Kennung, die bei Nichtverwendung 24 Stunden gültig ist und auf die Sie in der Anfrage selbst verweisen. Behandeln Sie diese Kennung als undurchsichtig, da sich ihr Format ändern kann.

Was das in Ihrer Arbeit verändert

Der Nutzen lässt sich am leichtesten erkennen, wenn man betrachtet, wie drei Rollen ihre Zeit bereits verbringen und an welcher Stelle die API Zeit zurückgibt.

Der Beschaffungsmanager oder Einkäufer

Bei einem EMS (Electronics Manufacturing Services-Anbieter) oder einem OEM (Original Equipment Manufacturer) stellt diese Person sicher, dass jedes Teil in einer Baugruppe auf Lager ist, findet einen Distributor, der den Liefertermin einhalten kann, versteht den Preis und platziert die Bestellung. Das können ein paar Bestellungen pro Woche oder 50 bis 100 pro Tag sein. Die Arbeit wird normalerweise Teil für Teil aus einer Tabellenkalkulation heraus erledigt: eine MPN eingeben, Verfügbarkeit prüfen, zum Distributor durchklicken und wiederholen. Autorisierte Distributoren werden zuerst geprüft, und die Suche wird nur dann auf nicht autorisierte Broker ausgeweitet, wenn nichts auf Lager ist. Viele Einkäufer prüfen unmittelbar vor der Bestellung ein zweites Mal, falls sich über Nacht etwas geändert hat.

Für jeden dieser Schritte gibt es oben ein Äquivalent. Eine einzige API-Abfrage ersetzt hundert einzelne Suchen. Die Verwendung des Filters nur für autorisierte Anbieter in der API entspricht genau dem Impuls „zuerst bevorzugt, dann ausweiten“ — nur als Einstellung statt als zweite Runde manueller Suche. Die erneute Prüfung vor der Bestellung wird zu einem Job, der nach Zeitplan läuft und nur dann alarmiert, wenn sich etwas geändert hat. Was zurückgewonnen wird, ist nicht das Urteilsvermögen, das beim Einkäufer bleibt, sondern das Tippen und Wechseln zwischen Tabs, das dieses derzeit aufbraucht. Vorab ausgehandelte Vertragspreise bleiben weiterhin beim Distributor, daher dient die API der Vorauswahl und dem Erkennen von Änderungen, nicht dem Ersetzen der Bestellung.

Der Designingenieur

Bei einem OEM verantwortet diese Person den gesamten elektrischen Design-Lebenszyklus — vom Blockdiagramm über die Komponentenauswahl, Schaltplanerfassung und das Layout bis zur Freigabe der BOM. Die maßgebliche Einschränkung ist eindeutig: Eine Komponente, die sich nicht beschaffen lässt, ist ein Designproblem. Deshalb wird Octopart als Validierungsschritt verwendet, um die Frage zu beantworten: „Kann dieses Teil tatsächlich gekauft werden, und zwar von mehr als einer Quelle?“ — und auch als Discovery-Tool zum Finden und Vergleichen von Kandidaten. Die Breite der Distributoren ist dabei selbst das Signal, denn ein Teil, das nur von einem einzigen Distributor geführt wird (oder zwar von mehreren, dessen Gesamtbestand aber Woche für Woche sinkt), ist ein Supply-Chain-Risiko, noch bevor es zu einem Beschaffungsproblem wird.

Über die API ausgeführt, hört diese Prüfung auf, ein Reflex von Teil zu Teil zu sein, und wird zu einem Gate. Jede Position einer BOM kann bei der Freigabe getestet werden, und alles mit nur einem Distributor, geringem Bestand oder einem Lifecycle-Flag kann sichtbar gemacht werden, bevor das Design freigegeben wird — statt erst Monate später. Die Sorge, die damit adressiert wird, ist spezifisch und teuer: dass ein Teil EOL (end of life) geht, nachdem es bereits ins Design aufgenommen wurde, und so ein Redesign erzwingt. Datenblätter können gleichzeitig in Ihre eigenen Tools gezogen werden, auch wenn Ingenieure Spezifikationen weiterhin direkt anhand des Datenblatts verifizieren werden — und das sollten sie auch.

Der Komponenteningenieur

Diese Rolle findet sich bei mittelgroßen bis großen OEMs, insbesondere in der Luft- und Raumfahrt, Verteidigung, Automobilindustrie und Medizintechnik. Diese Person erstellt in der Regel keine neuen Designs. Stattdessen verwaltet sie die bereits in Produktion befindlichen Teile: hält die Bibliothek freigegebener Teile aktuell, erkennt Obsoleszenz, bevor sie zur Krise wird, und qualifiziert Alternativen, wenn ein Teil abgekündigt wird. Gefährdete Teile stehen auf einer Beobachtungsliste, die regelmäßig geprüft wird, auch weil ein abgekündigtes Teil manchmal wieder auf den Markt zurückkehrt.

Eine selbstprüfende Watchlist ist der klarste Gewinn in diesem Artikel. Anstatt dass jemand daran denken muss, eine Liste erneut zu prüfen, durchläuft eine geplante Abfrage sie und meldet Ausnahmen. Da eine Anwendung die Supply- und Design-Bereiche zusammenhalten kann, kann die Bibliothek auf der Design-Seite gelesen und im selben Durchlauf mit Live-Marktdaten auf der Supply-Seite verglichen werden. So wird aus einer periodischen manuellen Prüfung ein fortlaufender Bericht. Octopart öffnet dabei weiterhin eher den Trichter, als ihn zu schließen: Kandidaten für Alternativen und die Marktverfügbarkeit kommen von hier, während die Verifizierung von Form, Fit, Funktion, Compliance und Lebenszyklus weiterhin in PLM-Tools (Product Lifecycle Management) und bei spezialisierten Datenanbietern erfolgt.

Was die drei gemeinsam haben

Keine dieser Personas möchte eine neue Website besuchen. Sie möchten, dass die Antwort innerhalb des Systems ankommt, in dem sie bereits arbeiten; genau in dem Moment, in dem sie benötigt wird, ohne dass jemand sie eigens abrufen muss. Genau dafür ist eine API da, und das kommt dem sehr nahe, wie Nexar seinen eigenen Zweck beschreibt: Informationen zu demokratisieren und Menschen zusammenzubringen, damit sie effizienter arbeiten und fundiertere Geschäftsentscheidungen treffen können.

Erste Schritte

1. Registrieren Sie sich unter portal.nexar.com mit einer E-Mail-Adresse und einem Passwort oder mit Google-, Facebook- oder Altium 365-Zugangsdaten. Organisationen, die bereits SSO (Single Sign-On) mit Altium 365 nutzen, können sich auf diese Weise anmelden.
2. Erstellen Sie eine Organisation oder treten Sie einer bei. Dieser Schritt ist erforderlich. Um einer bestehenden Organisation beizutreten, bitten Sie ein Mitglied, Sie einzuladen.
3. Sobald Sie sich registrieren, steht Ihnen eine vorgefertigte „Evaluation“-Anwendung zur Verfügung. Sie können zu Apps navigieren und zusätzliche Anwendungen erstellen, wenn Sie möchten.
4. Innerhalb des API-Dashboards gibt es eine Sandbox-Umgebung, die es Ihnen ermöglicht, sofort loszulegen. Wenn Sie bereit sind, die Daten in Ihr Tool oder Ihre Anwendung zu integrieren, können Sie zur Registerkarte Authorization navigieren und die Authentifizierungsdaten abrufen.
5. Übernehmen Sie die Client-ID und das Client-Secret aus der Registerkarte Authorization der Anwendung. Dabei handelt es sich um statische Anmeldedaten. Behandeln Sie das Secret wie ein Passwort.
6. Tauschen Sie diese gegen ein Access-Token aus. Nexar verwendet OAuth 2.0 (Open Authorization, Version 2.0), und Tokens sind 24 Stunden lang gültig. Supply-Abfragen verwenden den Client-Credentials-Grant; Design- und adm-Abfragen verwenden den Authorization-Code-Grant mit den Scopes OpenID, design.domain und user.access.

Sie können jedes der obigen Beispiele in einem GraphQL-Editor wie Nitro (früher Banana Cake Pop) oder Postman ausführen, bevor Sie auch nur eine Zeile Anwendungscode schreiben. Die Endpunkte sind api.nexar.com/graphql für die API, identity.nexar.com/connect/token für Tokens und files.nexar.com/File/Upload für Uploads. 

Wie es weitergeht

Sehen Sie die API in Aktion. Rob Barton, Head of Platform API bei Altium, erläutert im OnTrack-Podcast die Entwicklung der API von Altium und führt Live-Abfragen gegen Octopart-Supply-Daten durch: Altium API Deep Dive: Opening PCB Data to Developers auf YouTube.

Hören Sie sich die Episode an. OnTrack: The PCB Design Podcast, moderiert von Zach Peterson.

Erkunden Sie das Datenmodell. Nexar Voyager bietet eine visuelle Darstellung des GraphQL-Schemas.

Lesen Sie die Dokumentation. Eine vollständige Dokumentation und ein Glossar der Begriffe sind unter support.nexar.com verfügbar. Ausgearbeitete Codebeispiele werden auf dem NexarDeveloper-GitHub veröffentlicht.