RealityConnect API (RCAPI)
Introductie Overzicht van de Prevu3D RealityConnect API: mogelijkheden, regionale architectuur, OAuth2-verificatie en hoe deze past in RealityPlatform- en RealityTwin-integraties.
Aan de slag Vereisten, netwerktoegang en het beveiligingsmodel voor de RealityConnect API. Kies een OAuth-flow en volg de bijbehorende gids.
Uw eerste wijziging, van begin tot eind Een kopieerbare Client Credentials-doorloop: haal een token op, navigeer naar een site, hernoem deze, zie de wijziging in de Prevu3D Platform en maak deze ongedaan.
OAuth-scopesreferentie Elke OAuth-scope die de RealityConnect API verleent, wat deze autoriseert, en de valkuilen die nieuwe integraties tegenkomen.
Business objects en nodes doorzoeken Doorzoek de business objects en metadata van een twin, of doorzoek de nodehiërarchie van uw organisatie, via de RealityConnect API.
OAuth-flows Client Credentials-flow, Native Application-flow, Authorization Code + aangepaste-omleiding-flow
Rate Limits RealityConnect API rate-limit-buckets, responseheaders en hoe u 429 Too Many Requests afhandelt.
Foutcodes Referentie voor de benoemde foutcodes die RealityConnect API-bewerkingen retourneren, per endpoint, met de responsvorm en aanbevolen afhandeling voor elke code.
Wat contextId accepteert Welke id-types de padparameter contextId accepteert op twin- en RealityPlan-routes van de RealityConnect API, en waarom een geldig id toch 404 kan opleveren.
Levenscyclus van tokens in de praktijk Hoe u een RealityConnect API OAuth-token veilig cachet en vernieuwt tijdens een langlopende integratie: echte TTL's per flow en wat een token voortijdig ongeldig maakt.
Omgaan met inloggegevens Hoe u OAuth-inloggegevens van de RealityConnect API veilig opslaat, roteert en intrekt, en wat een gelekt access token kan bereiken.
Wat verwijderen echt doet, per resource Referentie voor wat het verwijderen van elke RealityConnect API-resource doet: welke verwijderingen herstelbaar zijn, wat ze blokkeert en wat er gebeurt met verwijzingen die achterblijven.
Knooptypen en hiërarchie De 10 knooptypen van de RealityConnect API, geldige ouder/kind-combinaties, welke typen de API kan aanmaken, en de structuur van de DataNode.
API-stabiliteit, versiebeheer en veroudering Hoe de RealityConnect API experimentele operaties markeert, wat telt als een breaking change, en het deprecatiebeleid.
Referentie voor POI-pictogrammen (textureId) De volledige set geldige textureId-waarden voor het maken van een point of interest (POI), en wat elk pictogram daadwerkelijk weergeeft.
Uw IDs vinden: organisaties, nodes en context Ontdek uw organization-ID, doorzoek de node-boom van de RealityConnect API en welke ID (contextId, organizationId) elke routefamilie verwacht.
Referentie: gedeelde multipart-upload Het initiëren-uploaden-voltooien-patroon dat de upload-endpoints van de RealityConnect API delen, inclusief de regel partNumber versus startIndex.
Getypeerde metadatawaarden en bijlagen Referentie voor metadata-eigenschapswaarden van de RealityConnect API: de union van string/getal/boolean/getagd object, de sentinel-types external-link en attachment, en de upload-, download- en verwijderflow voor bijlagen.
Node-thumbnails Upload, haal op en verwijder de thumbnailafbeelding van een datanode, en hoe includeThumbnail en thumbnailSignedUrl zich gedragen bij browse en search.
Netwerkvereisten Firewall-, proxy-, TLS- en egress-vereisten om de RealityConnect API vanuit een bedrijfsnetwerk te bereiken, plus een stapsgewijze connectiviteitsdiagnose.
RealityConnect API FAQ Antwoorden op de commerciële, architecturale en 'kan ik dit'-vragen over de RealityConnect API die al opkomen voordat een project is goedgekeurd.