Einführung

Die RealityConnect API ist die einzige öffentliche Schnittstelle, über die externe Systeme mit dem Prevu3D-Ökosystem interagieren können. Verwenden Sie sie, um Inhalte in RealityPlatform zu lesen und zu schreiben, RealityTwin-Arbeitsbereiche zu steuern, Ihre Organisation zu verwalten, Dateien und Datensätze hochzuladen und vieles mehr.

Wie die API organisiert ist

Einige Designentscheidungen sollten Sie kennen, bevor Sie mit der Entwicklung beginnen:

Regionale Basis-URLs. Die API läuft in mehreren Regionen (US East, EU Central, Asia North, Canada Central). Ihre Organisation ist in genau einer davon bereitgestellt. Holen Sie Ihre Basis-URL immer über den Discovery-Endpunkt ab, anstatt sie fest zu kodieren. Der Leitfaden Erste Schritte zeigt wie.
Alles ist auf Ihre Organisation beschränkt. Ein Token sieht nur die Knoten, auf die der Service-Benutzer Zugriff erhalten hat. Organisationsübergreifende Aufrufe sind nicht möglich.
Ressourcen liegen in einer Inhaltshierarchie. Die meisten Operationen zielen auf einen durch UUID identifizierten Knoten. Knoten bilden einen Baum (Organisation → Division → Site → Ordner → Asset), den Sie mit dem Endpunkt /nodes/{id}/browse durchlaufen können.
Dreischichtige Zugriffskontrolle. OAuth-Scopes, Inhaltszugriff und knotenspezifische Rollen müssen alle erfüllt sein, damit eine Anfrage erfolgreich ist. Im Abschnitt Sicherheitsmodell wird erläutert, wie Sie jede dieser Schichten konfigurieren.
JSON über HTTPS. Jeder Endpunkt akzeptiert und liefert JSON, verwendet Bearer-Token-Authentifizierung und folgt den standardmäßigen HTTP-Statuscodes.

OAuth-Authentifizierung

Die API-Authentifizierung basiert auf dem OAuth2-Protokoll. Unterstützte Flows:

OAuth-Flow	Beschreibung	Anwendungsbeispiele
Client Credentials	Server-zu-Server-Zugriff ohne angemeldeten Benutzer. Erstellt einen Service-Benutzer in Ihrer Organisation; Berechtigungen werden separat konfiguriert.	Skripte, Automatisierung, Backend-Integrationen, API-Tests
Native app	Ein Benutzer meldet sich im Browser an und erteilt Scopes. Authorization Code + Native Application mit PKCE und `http://localhost`-Redirect. Kein Client Secret.	Desktop-Apps, CLI-Tools, CAD-Plugins
Authorization Code + benutzerdefinierte HTTPS-Redirect-URI	Webanwendungen mit Callback-URL auf Ihrer eigenen Domain. Authorization Code ohne Native Application.	Demnächst verfügbar

Nächste Schritte

Erste Schritte: Voraussetzungen, Netzwerkzugriff, Sicherheitsmodell und Auswahl eines OAuth-Flows.
Client-Credentials-Flow: Server-zu-Server-Einrichtung von der OAuth-App-Erstellung bis zum ersten API-Aufruf.
Native-Anwendungsflow: Benutzeranmeldung mit PKCE und localhost-Redirect.
Interaktive API-Referenz: vollständiger Katalog der Endpunkte mit Request-/Response-Schemata und integriertem Request-Builder.