RealityConnect API (RCAPI)
Introduzione Panoramica della RealityConnect API di Prevu3D: funzionalità, architettura regionale, autenticazione OAuth2 e come si integra nelle integrazioni di RealityPlatform e RealityTwin.
Per iniziare Prerequisiti, accesso di rete e modello di sicurezza per la RealityConnect API. Scegli un flusso OAuth e segui la sua guida dedicata.
La tua prima modifica, dall'inizio alla fine Un percorso Client Credentials da copiare e incollare: ottieni un token, naviga fino a un sito, rinominalo, vedi la modifica nella Prevu3D Platform e poi annullala.
Riferimento agli scope OAuth Ogni scope OAuth concesso dalla RealityConnect API, cosa autorizza e le insidie che complicano le nuove integrazioni.
Ricerca di oggetti business e nodi Cerca all'interno degli oggetti business e dei metadati di un twin, oppure cerca nella gerarchia dei nodi della tua organizzazione, tramite l'API RealityConnect.
Flussi OAuth Flusso Client Credentials, Flusso Native Application e Flusso Authorization Code + redirect personalizzato
Limiti di frequenza I bucket dei limiti di frequenza della RealityConnect API, gli header di risposta e come gestire 429 Too Many Requests.
Codici di errore Riferimento ai codici di errore delle operazioni della RealityConnect API, per endpoint, con struttura della risposta e gestione consigliata.
Cosa accetta contextId Quali tipi di id accetta il parametro di percorso contextId sulle route twin e RealityPlan della RealityConnect API, e perché un id valido può restituire 404.
Ciclo di vita del token in pratica Come mettere in cache e rinnovare un token OAuth della RealityConnect API in sicurezza per un'integrazione di lunga durata: TTL reali per flusso e cosa invalida un token in anticipo.
Gestione delle credenziali Come archiviare, ruotare e revocare in modo sicuro le credenziali OAuth dell'API RealityConnect, e cosa può raggiungere un access token trapelato.
Cosa fa davvero l'eliminazione, per risorsa Riferimento su cosa fa l'eliminazione di ciascuna risorsa della RealityConnect API: quali eliminazioni sono recuperabili, cosa le blocca e cosa succede ai riferimenti rimasti.
Tipi di nodo e gerarchia I 10 tipi di nodo dell'API RealityConnect, quali combinazioni padre/figlio sono valide, quali tipi può creare l'API e la struttura del DataNode.
Stabilità, versioning e deprecazione dell'API Come la RealityConnect API contrassegna le operazioni sperimentali, cosa costituisce una modifica breaking, e la politica di deprecazione.
Riferimento alle icone dei POI (textureId) L'insieme completo dei valori validi di textureId per creare un punto di interesse (POI) e cosa rappresenta realmente ciascuna icona.
Trovare i tuoi ID: organizzazioni, nodi e contesto Scopri l'ID della tua organizzazione, esplora l'albero dei nodi dell'API RealityConnect e quale ID (contextId, organizationId) richiede ogni famiglia di route.
Riferimento: caricamento multipart condiviso Lo schema avvia, carica e finalizza condiviso dagli endpoint di caricamento della RealityConnect API, inclusa la regola partNumber rispetto a startIndex.
Valori di metadati tipizzati e allegati Riferimento per i valori delle proprietà di metadati dell'API RealityConnect: l'unione string/numero/booleano/oggetto taggato, i tipi sentinella external-link e attachment, e il flusso di upload, download ed eliminazione degli allegati.
Miniature dei nodi Carica, recupera e rimuovi l'immagine miniatura di un nodo dati, e come si comportano includeThumbnail e thumbnailSignedUrl su browse e search.
Requisiti di rete Requisiti di firewall, proxy, TLS ed egress per raggiungere la RealityConnect API da una rete aziendale, più una sequenza di diagnosi della connettività passo dopo passo.
RealityConnect API FAQ Risposte alle domande commerciali, architetturali e del tipo 'posso fare questo?' sulla RealityConnect API che emergono prima ancora che un progetto venga approvato.