Introductie
De RealityConnect API is het enige openbare oppervlak waarmee externe systemen kunnen interacteren met het Prevu3D-ecosysteem. Gebruik deze om inhoud in RealityPlatform te lezen en te schrijven, RealityTwin-werkruimten aan te sturen, uw organisatie te beheren, bestanden en datasets te uploaden en nog veel meer.
Hoe de API is georganiseerd
Section titled “Hoe de API is georganiseerd”Een paar ontwerpkeuzes zijn de moeite waard om te kennen voordat u begint met bouwen:
- Regionale basis-URL’s. De API draait in meerdere regio’s (US East, EU Central, Asia North, Canada Central). Uw organisatie wordt in precies één ervan geprovisioneerd. Haal uw basis-URL altijd op via het discovery-endpoint in plaats van deze hard te coderen. De Aan de slag-gids laat zien hoe.
- Alles is gescoped op uw organisatie. Een token ziet alleen nodes waartoe de servicegebruiker toegang heeft gekregen. Cross-organisatie-aanroepen zijn niet mogelijk.
- Resources bevinden zich in een inhoudshiërarchie. De meeste bewerkingen richten zich op een node die wordt geïdentificeerd door een UUID. Nodes vormen een boom (organisatie → divisie → site → map → asset) waardoor u kunt navigeren met het
/nodes/{id}/browse-endpoint. - Toegangscontrole in drie lagen. OAuth-scopes, inhoudstoegang en rollen per node moeten allemaal slagen om een verzoek te laten lukken. Zie het Beveiligingsmodel voor hoe u elk configureert.
- JSON via HTTPS. Elk endpoint accepteert en retourneert JSON, gebruikt bearer-tokenverificatie en volgt standaard HTTP-statuscodes.
OAuth-verificatie
Section titled “OAuth-verificatie”De API-verificatie is gebaseerd op het OAuth2-protocol. Ondersteunde flows:
| OAuth-flow | Beschrijving | Voorbeelden van gebruiksscenario’s |
|---|---|---|
| Client Credentials | Server-naar-server-toegang zonder ingelogde gebruiker. Maakt een servicegebruiker aan in uw organisatie; u configureert de rechten ervan afzonderlijk. | Scripts, automatisering, back-endintegraties, de API testen |
| Native app | Een gebruiker logt in via de browser en stemt in met scopes. Gebruikt Authorization Code + Native Application met PKCE en een http://localhost-omleiding. Geen client secret. | Desktopapps, CLI-tools, CAD-plug-ins |
| Authorization Code + aangepaste HTTPS-omleiding | Webapplicaties met een callback-URL op uw eigen domein. Gebruikt Authorization Code met PKCE en een exact overeenkomende HTTPS-omleidings-URI. | Webapps, SaaS-integraties |
Volgende stappen
Section titled “Volgende stappen”- Aan de slag: vereisten, netwerktoegang, beveiligingsmodel en het kiezen van een OAuth-flow.
- Client Credentials-flow: server-naar-server-installatie van het maken van een OAuth-app tot uw eerste API-aanroep.
- Native Application-flow: gebruikersaanmelding met PKCE en een localhost-omleiding.
- Authorization Code + aangepaste-omleiding-flow: aanmelding van webapp met PKCE en een aangepaste HTTPS-callback op uw domein.
- Interactieve API-referentie: volledige endpointcatalogus met request-/responseschema’s en een ingebouwde request-builder.
- Codefragmenten: kopieer-plak-Python-voorbeelden voor veelvoorkomende API-bewerkingen.
- Data Bundle-workflows: een data bundle maken, gegevens uploaden, verwerking starten, voortgang bewaken en invoerbestanden downloaden.