Premiers pas

Avant d’appeler la RealityConnect API, vérifiez que votre environnement peut l’atteindre, comprenez comment l’accès est appliqué et choisissez le flux OAuth adapté à votre intégration. Chaque flux dispose de son propre guide pas à pas.

Prérequis

Vous aurez besoin d’un accès administrateur d’organisation pour créer votre première application OAuth. Si vous ne l’avez pas encore, votre administrateur d’organisation peut vous accorder l’accès ou créer l’application pour vous.

URL de l’API et accès réseau

Avant de créer des identifiants OAuth, confirmez que la machine ou le serveur exécutant votre intégration peut atteindre l’API Prevu3D via HTTPS. Les pare-feu d’entreprise, proxys et listes d’autorisation bloquent souvent le trafic sortant et provoquent des délais d’expiration ou des erreurs DNS.

Votre intégration doit pouvoir atteindre :

OAuth et découverte d’API : https://cloud-api.prevu3d.com
RealityConnect API régionale (votre organisation utilise une région ; votre guide de flux explique comment découvrir l’URL exacte) :

Demandez à votre équipe informatique d’autoriser l’accès HTTPS sortant à ces hôtes si vous ne pouvez pas vous connecter.

Modèle de sécurité

L’accès à l’API est appliqué via trois couches. Une requête doit passer les trois pour réussir ; si l’une d’elles refuse l’accès, la requête échoue.

Couche 1 — Scopes OAuth. Configurés sur l’application OAuth. Les scopes définissent les familles d’opérations que l’application est autorisée à effectuer (par ex. read:basic, read:hierarchy).

Couche 2 — Accès au contenu. Configuré sur le compte qui appelle l’API. Pour Client Credentials, il s’agit de l’utilisateur de service créé avec votre application OAuth. Pour les flux Authorization Code, il s’agit de l’utilisateur connecté. Cette couche détermine quels nœuds (organisations, divisions, sites, etc.) l’appelant peut voir et sur lesquels il peut agir.

Couche 3 — Accès par rôle / permission. Configuré sur ce même compte, par nœud. Détermine ce que l’appelant peut faire avec ce contenu (lire, modifier, gérer, etc.).

Chaque guide de flux explique où et comment configurer ces couches pour votre cas d’utilisation.

Choisir un flux OAuth

Choisissez le flux OAuth qui correspond à votre intégration, puis suivez son guide dédié :

Flux	Idéal pour	Guide
Client Credentials	Intégrations serveur à serveur, scripts et services back-end agissant au nom de votre organisation	Flux Client Credentials
Native app	Intégrations où un utilisateur se connecte via le navigateur (apps de bureau, CLI, plugins). Authorization Code + Native Application avec PKCE, redirect localhost, sans client secret.	Flux pour application native
Authorization Code + redirection HTTPS personnalisée	Applications web avec URL de callback sur votre propre domaine	Bientôt disponible

Vous ne savez pas par où commencer ? Client Credentials est le chemin le plus simple pour tester l’API ou construire une automatisation côté serveur. Utilisez Native app lorsque les appels API doivent s’exécuter en tant qu’utilisateur connecté spécifique.

Points de terminaison expérimentaux

Certaines opérations dans la référence API sont marquées expérimentales. Dans le document OpenAPI, elles déclarent x-scalar-stability: experimental.

Traitez les points de terminaison expérimentaux différemment des points stables :

Anticipez des changements. Les chemins, paramètres, charges utiles, réponses, erreurs ou disponibilité peuvent changer sans les mêmes garanties de stabilité que le reste de l’API.
Isolez l’utilisation. Pour les charges de production, préférez les opérations stables. Si vous utilisez quelque chose d’expérimental, gardez-le derrière un petit adaptateur pour pouvoir ajuster rapidement lorsque le contrat évolue.
Restez à jour. Suivez les notes de version et revisitez la référence API après les mises à niveau pour ne pas être surpris par des changements de comportement.

Et ensuite ?

Choisissez un flux parmi les options suivantes et suivez son guide de bout en bout.

Explorez la référence API pour voir toutes les opérations disponibles.