Introduction
La RealityConnect API est l’unique surface publique qui permet à des systèmes externes d’interagir avec l’écosystème Prevu3D. Utilisez-la pour lire et écrire du contenu dans RealityPlatform, piloter des espaces de travail RealityTwin, gérer votre organisation, téléverser des fichiers et des jeux de données, et bien plus encore.
Comment l’API est organisée
Section intitulée « Comment l’API est organisée »Quelques choix de conception à connaître avant de commencer :
- URL de base régionales. L’API fonctionne dans plusieurs régions (US East, EU Central, Asia North, Canada Central). Votre organisation est provisionnée dans exactement une d’entre elles. Récupérez toujours votre URL de base depuis l’endpoint de découverte plutôt que de la coder en dur. Le guide Premiers pas explique comment procéder.
- Tout est limité au périmètre de votre organisation. Un jeton ne voit que les nœuds auxquels l’utilisateur de service a été autorisé. Les appels inter-organisations ne sont pas possibles.
- Les ressources vivent dans une hiérarchie de contenu. La plupart des opérations ciblent un nœud identifié par UUID. Les nœuds forment un arbre (organisation → division → site → dossier → asset) que vous pouvez parcourir avec l’endpoint
/nodes/{id}/browse. - Contrôle d’accès à trois couches. Les scopes OAuth, l’accès au contenu et les rôles par nœud doivent tous passer pour qu’une requête aboutisse. Voir la section Modèle de sécurité pour savoir comment configurer chacune d’elles.
- JSON sur HTTPS. Chaque endpoint accepte et renvoie du JSON, utilise une authentification par jeton bearer et suit les codes d’état HTTP standards.
Authentification OAuth
Section intitulée « Authentification OAuth »L’authentification de l’API est basée sur le protocole OAuth2. Flux pris en charge :
| Flux OAuth | Description | Exemples de cas d’utilisation |
|---|---|---|
| Client Credentials | Accès serveur à serveur sans utilisateur connecté. Crée un utilisateur de service dans votre organisation ; vous configurez ses permissions séparément. | Scripts, automatisation, intégrations back-end, tests de l’API |
| Native app | Un utilisateur se connecte via le navigateur et approuve les scopes. Authorization Code + Native Application avec PKCE et redirect http://localhost. Pas de client secret. | Apps de bureau, outils CLI, plugins CAO |
| Authorization Code + redirection HTTPS personnalisée | Applications web avec URL de callback sur votre propre domaine. Authorization Code sans Native Application. | Bientôt disponible |
Prochaines étapes
Section intitulée « Prochaines étapes »- Premiers pas : prérequis, accès réseau, modèle de sécurité et choix d’un flux OAuth.
- Flux Client Credentials : configuration serveur à serveur, de la création de l’application OAuth au premier appel API.
- Flux pour application native : connexion utilisateur avec PKCE et redirect localhost.
- Référence API interactive : catalogue complet des endpoints avec les schémas de requête/réponse et un constructeur de requêtes intégré.