Introduction

  • Updated on Jul 28, 2025
  • Published on Jul 1, 2025
  • 1 minute(s) read
Prev Next

Prevu3D ecosystem allows external connections through a single service called RealityConnect API.

The API authentication is based on the OAuth2 protocol. This specification describes how the authentication flow is made based on the various use case. Here’s a brief description of the various OAuth workflow supported by Prevu3D :

OAuth Flow

Description

Use case examples

Authorization code (online)

Login to the API on the behalf of an user. The user will have to accept the application and the scopes it requires.

  • Cloud application using Prevu3D Platform capabilities

Authorization code (native)

Same as online authorization code except your app will not have a secret to exchange its tokens.

  • Desktop application using Prevu3D Platform capabilities (CAD Software plugin, desktop viewer…)

Client credentials

Used for server to server communication without login in on behalf of a user. This will create a service user in your organization for which you will need to setup permissions.

  • Testing the API

  • Synchronizing data between systems

To be able to use the API you will need to create register an application and obtain a token based on the OAuth flow you chose.