Primeros pasos

Antes de llamar a la API de RealityConnect, confirma que tu red puede acceder a ella, comprende cómo se aplica el control de acceso y elige el flujo OAuth que se ajuste a tu integración. Cada flujo tiene su propia guía paso a paso.

Requisitos previos

Necesitarás acceso de administrador de la organización para crear tu primera aplicación OAuth. Si aún no lo tienes, el administrador de tu organización puede concederte acceso o crear la aplicación por ti.

URLs de la API y acceso de red

Antes de crear las credenciales de OAuth, confirma que la máquina o el servidor que ejecuta tu integración puede acceder a la API de Prevu3D a través de HTTPS. Los firewalls corporativos, los proxies y las listas de permitidos suelen bloquear el tráfico saliente y provocar tiempos de espera de conexión o errores de DNS.

Tu integración debe poder acceder a:

Detección de OAuth y de la API: https://cloud-api.prevu3d.com
API regional de RealityConnect (tu organización usa una única región; tu guía de flujo explica cómo descubrir la URL exacta):

Pide a tu equipo de TI que permita el acceso HTTPS saliente a estos hosts si no puedes conectarte.

Modelo de seguridad

El acceso a la API se aplica a través de tres capas. Una solicitud debe superar todas ellas para tener éxito; si cualquier capa deniega el acceso, la solicitud falla.

Capa 1 — Ámbitos (scopes) de OAuth. Se configuran en la aplicación OAuth. Los ámbitos definen qué familias de operaciones puede realizar la aplicación (p. ej., read:basic, read:hierarchy).

Capa 2 — Acceso al contenido. Se configura en la cuenta que llama a la API. Para Client Credentials, es el usuario de servicio creado con tu aplicación OAuth. Para el flujo de aplicación nativa, es el usuario que ha iniciado sesión. Esta capa determina qué nodos (organizaciones, divisiones, sitios, etc.) puede ver el llamador y sobre cuáles puede actuar.

Capa 3 — Acceso por rol / permiso. Se configura en esa misma cuenta, por nodo. Determina qué puede hacer el llamador con ese contenido (leer, editar, gestionar, etc.).

Cada guía de flujo explica dónde y cómo configurar estas capas para tu caso de uso.

Elige un flujo OAuth

Elige el flujo OAuth que se ajuste a cómo se ejecuta tu integración y sigue su guía dedicada:

Flujo	Ideal para	Guía
Client Credentials	Integraciones de servidor a servidor, scripts y servicios de backend que actúan en nombre de tu organización	Flujo de Client Credentials
Aplicación nativa	Integraciones en las que un usuario inicia sesión a través de un navegador (apps de escritorio, herramientas CLI, plugins). Usa Authorization Code + Native Application con PKCE, un redireccionamiento a localhost y sin secreto de cliente.	Flujo de aplicación nativa
Authorization Code + redireccionamiento HTTPS personalizado	Aplicaciones web con una URL de retorno en tu propio dominio	Flujo de Authorization Code + redireccionamiento personalizado

¿No sabes por dónde empezar? Client Credentials es la vía más sencilla para probar la API o crear automatización del lado del servidor. Usa el flujo de aplicación nativa cuando las llamadas a la API deban ejecutarse como un usuario específico con sesión iniciada.

Endpoints experimentales

Algunas operaciones de la referencia de la API están marcadas como experimentales.

Trata los endpoints experimentales de forma diferente a los estables:

Espera cambios. Las rutas, los parámetros, las cargas útiles, las respuestas, los errores o la disponibilidad pueden cambiar sin las mismas garantías de estabilidad que el resto de la API.
Aísla su uso. En tu integración, prioriza las operaciones estables. Si dependes de algo experimental, mantenlo detrás de un pequeño adaptador para poder ajustarte rápidamente cuando el contrato evolucione.
Mantente al día. Sigue las notas de la versión y revisa la referencia de la API tras las actualizaciones para que los cambios de comportamiento no te sorprendan.

¿Qué sigue?

Elige un flujo entre las siguientes opciones y sigue su guía de principio a fin.

Explora la referencia de la API para ver todas las operaciones disponibles.