Skip to content
Sean Higgins Di, Jul 5, '22 4 min read

Alles, was Sie über die NavVis-APIs wissen müssen

Wollten Sie NavVis IVION schon immer an Ihre Bedürfnisse anpassen? Mit den NavVis-APIs ist das kein Problem!

Wenn Sie regelmäßig NavVis IVION nutzen, haben Sie sich vielleicht schon einmal gefragt: Ist es möglich, NavVis IVION besser in meine andere Software zu integrieren? Könnte man diesen Teil der Benutzeroberfläche ändern? Gibt es eine Möglichkeit, Workflows und Dienste zu erstellen, die individuell auf meine Bedürfnisse zugeschnitten sind?

Gute Nachrichten: Ja, ja und ja! NavVis bietet zwei APIs, die es Entwicklerinnen und Entwicklern ermöglichen, genau solche Anpassungen (und noch viele mehr) vorzunehmen und eigene Skripte und Anwendungen auf der Basis von Daten oder Funktionen von NavVis IVION zu erstellen. Dadurch wird NavVis IVION zu einer enorm flexiblen Plattform für die Visualisierung und Nutzung von 3D-Daten.

Diese APIs richten sich an alle, die NavVis IVION für ihre Zwecke nutzen. Zum Beispiel:

  • Laserscanning-Profis, die NavVis IVION in Tools von Drittanbietern wie Autodesk integrieren möchten, um Konstruktions- oder Scan-to-BIM-Workflows zu verbessern
  • Große Fertigungsunternehmen, die NavVis IVION mit Tools wie SAP verbinden möchten, um ihre Planungs-, Wartungs- und Betriebsprozesse zu optimieren
  • Software- oder Technologieanbieter, die 3D-Geodaten zur Entwicklung eigener Lösungen nutzen
  • Alle Unternehmen, die für ihre tägliche Arbeit 3D-Daten und digitale Zwillinge nutzen

Wenn das auf Sie zutrifft, Sie sich aber nicht sicher sind, wo genau Sie in Sachen API ansetzen sollten, keine Sorge: In diesem Artikel erfahren Sie alles, was Sie wissen müssen. Dafür werden wir klären, was eine API genau ist, welche Arten von APIs NavVis anbietet und welche Arten von Anwendungen und Skripten sich darauf aufbauend entwickeln lassen. Am Ende des Artikels verfügen Sie dann über das notwendige Wissen, um die nächsten Schritte zu planen.

Was ist eine API?

Die Abkürzung API steht für Application Programming Interface und bezeichnet eine Anwendungsprogrammierschnittstelle. Diese Tools werden von Unternehmen wie Google, Facebook oder NavVis verwendet, um Daten oder Funktionen ihrer Anwendungen für Dritte zugänglich zu machen.

Eine API enthält eine dokumentierte Liste von Operationen, die ein Entwickler bzw. eine Entwicklerin für eigene Zwecke und Anwendungen verwenden kann. Diese Operationen kann man sich als die Bausteine für benutzerdefinierte Anwendungen oder Skripte vorstellen. Häufig genutzte Operationen wären beispielsweise das Abrufen bzw. das Bearbeiten eines Datensatzes oder das Einbetten der angepassten Version einer Anwendung in Ihre Webseite.

Das Schöne an einer API ist, dass man nicht verstehen muss, wie die Operationen in der Anwendung implementiert werden. Wenn man weiß, wie man die API der Anwendung verwendet, kann man Daten oder Funktionen von NavVis IVION für seine eigenen Zwecke nutzen.

Eine Kurzanleitung für die NavVis APIs

NavVis bietet zwei verschiedene APIs für Entwicklerinnen und Entwickler: eine Frontend-API und eine REST-API. Diese Tools bieten verschiedene Möglichkeiten, mit NavVis IVION zu kommunizieren und können in Kombination oder einzeln verwendet werden.

Schauen wir uns nun einmal genauer an, was diese APIs sind und was man mit ihnen machen kann.

Was ist eine Frontend-API?

Kurz gesagt, bietet eine Frontend-API Zugriff auf die Benutzeroberfläche - oder das Frontend - einer Anwendung.

Das bedeutet, dass sie dank der NavVis' Frontend-API NavVis IVION steuern, verbessern oder anpassen können. Sie (bzw. Ihre Entwicklerinnen) können JavaScript oder TypeScript verwenden, um NavVis IVION in eine Webseite einzubetten und eine Benutzeroberfläche zu erstellen, die speziell auf Ihre Bedürfnisse oder Anwendungsfälle abgestimmt ist.

NavVis-IVION-Core-Hero-blog-post

Wofür kann die API genutzt werden?

Die Frontend-API kann genutzt werden, um eine Vielzahl von Anpassungen vorzunehmen. Hier sind ein paar Anwendungsbeispiele:

  • Passen Sie NavVis IVION an das visuelle Branding Ihres Unternehmens an
  • Ändern Sie das Seitenleistenmenü oder andere UI-Elemente
  • Fügen Sie neue UI-Elemente hinzu
  • Ermöglichen Sie Ihren Kunden einen Fernzugriff auf NavVis IVION (z. B. für virtuelle Rundgänge)
  • Konfigurieren Sie NavVis IVION so, dass die Plattform auf bestimmte Anfragen bzw. Muster reagiert
  • Konzipieren und entwickeln Sie individuelle Workflows (z. B. zum Tracking von Defekten)
  • Etc.

Was ist eine REST-API?

Eine REST-API ist eine API, welche die Designkriterien einer REpresentational State Transfer-Architektur erfüllt. (Für diesen Blogbeitrag wollen wir es bei dieser kurzen Erklärung belassen. Wenn Sie sich gerne weiter in das Thema einlesen möchten, finden Sie hier einen interessanten Artikel von Red Hat.)

api-rest-model-png

Kurz gesagt: Die REST API bietet Zugang zu NavVis IVION-Funktionen, die im Hintergrund ausgeführt werden. So können API-Endpunkte und HTML-Anfragen verwendet werden, um auf Daten und Funktionen in IVION zuzugreifen, die nicht über die Benutzeroberfläche verfügbar sind.

Wofür kann die API genutzt werden?

Mit der REST-API können Sie eigene Skripte oder HTTP-Dienste erstellen. Hier sind ein paar Anwendungsbeispiele:

  • Hinzufügen von IoT-Funktionen und Visualisierung von Sensordatendiagrammen in Dialogfeldern für jeden Point of Interest (POI)
  • Abrufen von Artefakten aus verarbeiteten Datensätzen
  • Änderungen an großen Gruppen von Usern gleichzeitig vornehmen
  • Zugriffsberechtigungen von großen Gruppen von Usern gleichzeitig ändern
  • Automatisches Abrufen und Aktualisieren von POI-Daten
  • Etc.

Wie die Implementierung gelingt

Wenn Sie im Unternehmen nicht über eigene Entwicklungskapazitäten verfügen, können Sie auch ein externes Unternehmen mit der Entwicklung einer Lösung beauftragen. APIs erleichtern die Entwicklung benutzerdefinierter Skripte und Anwendungen, ihre Benutzung erfordert jedoch ein gewisses Fachwissen seitens der Entwicklerinnen und Entwickler.

Die erste Anlaufstelle bei jeder API sollte die Dokumentation sein: Diese enthält alle notwendigen Informationen über die Plattform, alle verfügbaren Tutorials und eine Liste sämtlicher Operationen, die genutzt werden können.

So finden Sie auch in der NavVis-Dokumentation mehrere Dokumente, die Entwicklerinnen und Entwicklern dabei helfen sollen, sich zurechtzufinden und mit der API zu arbeiten.

Wie geht es weiter?

Wenn Sie bereits NavVis-Kunde sind, wenden Sie sich bitte an Ihren Customer Success Manager oder erstellen Sie ein Ticket im NavVis-Supportportal.

Wenn Sie noch kein Kunde sind und daran interessiert sind, etwas auf Basis der NavVis APIs zu entwickeln, senden Sie bitte hier eine Anfrage, um mit unserem Partner & Platform Team in Kontakt zu treten.

Sean Higgins ist selbstständiger Technikjournalist, ehemaliger Redakteur einer Fachzeitschrift und Naturliebhaber. Er ist der Meinung, dass 3D-Technologien klar und verständlich erklärt und besprochen werden sollten.