RealityConnect API FAQ
Manche Fragen gehören zu keiner einzelnen Referenzseite. Sie sind kommerzieller oder architektonischer Natur oder betreffen das, was die API nicht kann. Diese Seite sammelt die Fragen, die in Support-, Solutions-Engineering- und Vertriebsgesprächen am häufigsten aufkommen, bevor auch nur eine Zeile Code geschrieben wird.
Kann ich mit einem Satz Anmeldedaten auf mehr als eine Organisation zugreifen?
Abschnitt betitelt „Kann ich mit einem Satz Anmeldedaten auf mehr als eine Organisation zugreifen?“Nein, das ist so vorgesehen. Jedes OAuth-Token ist dauerhaft auf die Organisation beschränkt, für die es ausgestellt wurde, und es gibt keine Möglichkeit, mit einem einzigen Satz Anmeldedaten zwischen Organisationen zu wechseln oder organisationsübergreifend zu lesen. Siehe die Einführung und die Funktionsübersicht für das vollständige Bild dessen, was die API kann und nicht kann.
Warum ist meine Liste leer, obwohl mein Token alle Scopes hat?
Abschnitt betitelt „Warum ist meine Liste leer, obwohl mein Token alle Scopes hat?“Prüfen Sie Inhaltszugriff und Rolle, nicht die Scopes. OAuth-Scopes sind nur Ebene 1 des Sicherheitsmodells, sodass ein Token mit allen Scopes weiterhin nur die Knoten sieht, auf die das aufrufende Konto Inhaltszugriff hat, und dort nur innerhalb seiner zugewiesenen Rolle handeln kann. Ein leeres Ergebnis bedeutet fast immer Ebene 2 oder 3, nicht einen fehlenden Scope. OAuth-Scopes nach Aufgabe bestätigt, ob Sie überhaupt die richtigen Scopes haben; prüfen Sie von dort aus Inhaltszugriff und Rolle des aufrufenden Kontos auf diesem Knoten.
Wie finde ich die Region meiner Organisation heraus?
Abschnitt betitelt „Wie finde ich die Region meiner Organisation heraus?“Rufen Sie GET /oauth/api-info mit Ihrem Access Token auf. Die Antwort enthält Ihre regionale apiUrl und Ihre organization.id. Kodieren Sie niemals eine regionale URL fest. Siehe Erste Schritte und den Client-Credentials-Flow für ein durchgerechnetes Beispiel.
Kann ich die API ohne RealityTwin-Lizenz oder RealityPlan-Seat nutzen?
Abschnitt betitelt „Kann ich die API ohne RealityTwin-Lizenz oder RealityPlan-Seat nutzen?“Für den größten Teil ja. Eine RealityTwin-Data-Manager-Lizenz wird nur bei Aufrufen verbraucht, die Twin-Inhalte betreffen (Assets, POIs, Zonen, Entwürfe, Suche, Objektmetadaten, Embed-Sessions und die Asset-Library). Benutzer- und Einladungsverwaltung, Rollen und der Discovery-Aufruf /oauth/api-info berühren keinen Twin und verbrauchen keine Lizenz. Einige RealityPlan-bezogene Endpunkte verbrauchen zusätzlich einen RealityPlan-Seat. Siehe Lizenzierung.
Gibt es eine Test- oder Sandbox-Umgebung?
Abschnitt betitelt „Gibt es eine Test- oder Sandbox-Umgebung?“Heute gibt es keine eigene Sandbox- oder Testumgebung. Der einfachste Weg, die API auszuprobieren, ist eine Client-Credentials-Anwendung in Ihrer eigenen Organisation. Siehe OAuth-Flow auswählen.
Wie kann ich die IDs meines Systems auf Prevu3D-Objekten festhalten?
Abschnitt betitelt „Wie kann ich die IDs meines Systems auf Prevu3D-Objekten festhalten?“Dafür gibt es kein reserviertes Feld. Verwenden Sie eine einfache String- oder Zahleneigenschaft in den Metadaten des Objekts, zum Beispiel einen Abschnitt namens „External IDs” mit der ID Ihres Systems. Metadaten sind frei formbare Schlüssel-Wert-Daten, kein festes Schema, also funktioniert jeder Eigenschaftsname, ohne dass vorab etwas bereitgestellt werden muss. Siehe Typisierte Metadatenwerte und Anhänge.
Wie geht es weiter?
Abschnitt betitelt „Wie geht es weiter?“- Funktionsübersicht für das, was die API lesen, schreiben und überhaupt nicht kann.
- Erste Schritte für das Sicherheitsmodell, die Lizenzierung und die Wahl eines OAuth-Flows.
- Erkunden Sie die API-Referenz für den vollständigen Endpunktkatalog.