Ga naar inhoud
Prevu3D

RealityConnect API FAQ

Sommige vragen horen niet bij één specifieke referentiepagina. Ze zijn commercieel of architecturaal van aard, of gaan over wat de API niet doet. Deze pagina verzamelt de vragen die het vaakst terugkomen in support-, solutions-engineering- en salesgesprekken, nog voordat er één regel code is geschreven.

Kan ik met één set inloggegevens toegang krijgen tot meer dan één organisatie?

Section titled “Kan ik met één set inloggegevens toegang krijgen tot meer dan één organisatie?”

Nee, dat is met opzet zo. Elk OAuth-token is permanent gescoped op de organisatie waarvoor het is uitgegeven, en er is geen manier om met één set inloggegevens te wisselen tussen organisaties of organisatie-overstijgend te lezen. Zie de Introductie en het Overzicht van mogelijkheden voor het volledige beeld van wat de API wel en niet kan.

Waarom is mijn lijst leeg terwijl mijn token alle scopes heeft?

Section titled “Waarom is mijn lijst leeg terwijl mijn token alle scopes heeft?”

Controleer inhoudstoegang en rol, niet de scopes. OAuth-scopes zijn slechts laag 1 van het beveiligingsmodel, dus een token met alle scopes ziet nog steeds alleen de nodes waartoe het aanroepende account inhoudstoegang heeft, en kan daar alleen handelen binnen de toegewezen rol. Een leeg resultaat betekent bijna altijd een probleem in laag 2 of 3, niet een ontbrekende scope. OAuth-scopes per taak bevestigt of u überhaupt de juiste scopes heeft; controleer vervolgens de inhoudstoegang en rol van het aanroepende account op die node.

Hoe vind ik de regio van mijn organisatie?

Section titled “Hoe vind ik de regio van mijn organisatie?”

Roep GET /oauth/api-info aan met uw access token. Het antwoord bevat uw regionale apiUrl en uw organization.id. Codeer een regionale URL nooit hard. Zie Aan de slag en de Client Credentials-flow voor een uitgewerkt voorbeeld.

Kan ik de API gebruiken zonder RealityTwin-licentie of RealityPlan-seat?

Section titled “Kan ik de API gebruiken zonder RealityTwin-licentie of RealityPlan-seat?”

Voor het grootste deel wel. Een RealityTwin Data Manager-licentie wordt alleen verbruikt door aanroepen die twin-inhoud raken (assets, POI’s, zones, concepten, zoeken, objectmetadata, embed-sessies en de assetbibliotheek). Gebruikers- en uitnodigingsbeheer, rollen, en de discovery-aanroep /oauth/api-info raken geen enkele twin en verbruiken geen licentie. Sommige RealityPlan-gerelateerde endpoints verbruiken ook een RealityPlan-seat. Zie Licenties.

Is er een test- of sandboxomgeving?

Section titled “Is er een test- of sandboxomgeving?”

Er bestaat vandaag geen aparte sandbox- of proefomgeving. De eenvoudigste manier om de API te proberen is een Client Credentials-applicatie in uw eigen organisatie. Zie Kies een OAuth-flow.

Hoe bewaar ik de ID’s van mijn systeem op Prevu3D-objecten?

Section titled “Hoe bewaar ik de ID’s van mijn systeem op Prevu3D-objecten?”

Hiervoor is geen gereserveerd veld. Gebruik een gewone tekst- of getaleigenschap in de metadata van het object, bijvoorbeeld een sectie genaamd “External IDs” met de ID uit uw systeem. Metadata is vrije key/value-data, geen vast schema, dus elke eigenschapsnaam werkt zonder dat u van tevoren iets hoeft te provisioneren. Zie Getypeerde metadatawaarden en bijlagen.

Wat is de volgende stap?

Section titled “Wat is de volgende stap?”